這篇文章給大家介紹jeecg-boot中怎么新建一個module模塊,內(nèi)容非常詳細(xì),感興趣的小伙伴們可以參考借鑒,希望對大家能有所幫助。
成都創(chuàng)新互聯(lián)一直通過網(wǎng)站建設(shè)和網(wǎng)站營銷幫助企業(yè)獲得更多客戶資源。 以"深度挖掘,量身打造,注重實效"的一站式服務(wù),以成都網(wǎng)站建設(shè)、網(wǎng)站建設(shè)、移動互聯(lián)產(chǎn)品、成都全網(wǎng)營銷推廣服務(wù)為核心業(yè)務(wù)。10余年網(wǎng)站制作的經(jīng)驗,使用新網(wǎng)站建設(shè)技術(shù),全新開發(fā)出的標(biāo)準(zhǔn)網(wǎng)站,不但價格便宜而且實用、靈活,特別適合中小公司網(wǎng)站制作。網(wǎng)站管理系統(tǒng)簡單易用,維護(hù)方便,您可以完全操作網(wǎng)站資料,是中小公司快速網(wǎng)站建設(shè)的選擇。
新建maven項目 取名jeecg-boot-module-jm
可以采用idea、myeclipse 等工具來新建一個maven項目
其中 pom.xml文件內(nèi)容如下
4.0.0 jeecg-boot-module-jm 2.0.2 org.jeecgframework.boot jeecg-boot-parent 2.0.2 aliyun aliyun Repository http://maven.aliyun.com/nexus/content/groups/public false jeecg jeecg Repository http://maven.jeecg.org/nexus/content/repositories/jeecg false org.jeecgframework.boot jeecg-boot-base-common
注意:我這個pom文件直接復(fù)制了jeecg-boot-module-system 內(nèi)容,將jeecg-boot-module-system名稱改為jeecg-boot-module-jm,注意注釋了
org.springframework.boot spring-boot-maven-plugin
這段代碼,因為新建的項目要打包為jar在jeecg-boot-module-system引用,所以不需要把該項目打包一個springboot項目,注釋上面的代碼就可以了。
在項目根目錄新建包名org.jeecg.modules.hello(以issues:373為例,也可以使用其他包名,記住這個包名,后面在接口問題swagger-ui使用到)
(以issues:373為例,后面針對提出的問題,進(jìn)行一一解答)這段代碼后面在swagegr-ui中訪問不到,因為方法上沒有添加@ApiOperation
package org.jeecg.modules.hello; import org.jeecg.common.api.vo.Result; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import io.swagger.annotations.Api; import lombok.extern.slf4j.Slf4j; /** * 測試新的module * @author chengtg * */ @Slf4j @Api(tags="新建module--jm") @RestController @RequestMapping("/hello") public class HelloController { @GetMapping(value="/") public Resulthello(){ Result result = new Result (); result.setResult("hello word!"); result.setSuccess(true); return result; } }
注意:我修改了注釋(@Api(tags="新建module--jm")),后面在swagegr-ui文檔用到
將新建的jeecg-boot-module-jm 納入jeecg-boot-parent中
在jeecg-boot-framework項目中的pom文件 modules中添加
結(jié)果如下代碼
jeecg-boot-base-common jeecg-boot-module-system jeecg-boot-module-jm
在jeecg-boot-module-system項目中依賴 jeecg-boot-module-jms
修改jeecg-boot-module-system項目的pom文件
org.jeecgframework.boot jeecg-boot-base-common org.jeecgframework.boot jeecg-boot-module-jm 2.0.2
編譯整個jeecg-boot-framework
如果編譯如下:
[INFO] --- maven-install-plugin:2.5.2:install (default-install) @ jeecg-boot-module-system --- [INFO] Installing /Users/chengtg/WS-platform/jeecg-boot-framework/jeecg-boot-module-system/target/jeecg-boot-module-system-2.0.2.jar to /Users/chengtg/.m2/repository/org/jeecgframework/boot/jeecg-boot-module-system/2.0.2/jeecg-boot-module-system-2.0.2.jar [INFO] Installing /Users/chengtg/WS-platform/jeecg-boot-framework/jeecg-boot-module-system/pom.xml to /Users/chengtg/.m2/repository/org/jeecgframework/boot/jeecg-boot-module-system/2.0.2/jeecg-boot-module-system-2.0.2.pom [INFO] ------------------------------------------------------------------------ [INFO] Reactor Summary for jeecg-boot-parent 2.0.2: [INFO] [INFO] jeecg-boot-parent .................................. SUCCESS [ 0.236 s] [INFO] jeecg-boot-base-common ............................. SUCCESS [ 1.143 s] [INFO] jeecg-boot-module-jm ............................... SUCCESS [ 1.066 s] [INFO] jeecg-boot-module-system ........................... SUCCESS [ 3.125 s] [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 5.872 s [INFO] Finished at: 2019-08-04T21:41:09+08:00 [INFO] ------------------------------------------------------------------------
說明,新建項目jeecg-boot-module-jm并在jeecg-boot-module-system中依賴,成功!
http://localhost:8080/jeecg-boot/doc.html
截圖如下:
問題來了:為什么新添加的HelloController中@Api(tags="新建module--jm")沒有 顯示
原因查看Swagger2Config配置,Swagger2Config.java
因為截圖中紅色圈出來的 部分
//加了ApiOperation注解的類,才生成接口文檔 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
表示只有在controller類的方法上要添加ApiOperation注解的,否則是不生成swagegr-ui文檔
修改jeecg-boot-module-system-jm項目HelloController類,給hello方法添加ApiOperation注解
package org.jeecg.modules.hello; import org.jeecg.common.api.vo.Result; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; import lombok.extern.slf4j.Slf4j; /** * 測試新的module * @author chengtg * */ @Slf4j @Api(tags="新建module--jm") @RestController @RequestMapping("/hello") public class HelloController { @ApiOperation("測試hello方法") @GetMapping(value="/") public Resulthello(){ Result result = new Result (); result.setResult("hello word!"); result.setSuccess(true); return result; } }
重新編譯啟動。
再次訪問接口文檔swagger:http://localhost:8080/jeecg-boot/doc.html
代碼如下:
package org.jeecg.config; import java.util.HashMap; import java.util.LinkedHashMap; import java.util.Map; import javax.servlet.Filter; import org.apache.shiro.mgt.DefaultSessionStorageEvaluator; import org.apache.shiro.mgt.DefaultSubjectDAO; import org.apache.shiro.mgt.SecurityManager; import org.apache.shiro.spring.LifecycleBeanPostProcessor; import org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor; import org.apache.shiro.spring.web.ShiroFilterFactoryBean; import org.apache.shiro.web.mgt.DefaultWebSecurityManager; import org.jeecg.modules.shiro.authc.ShiroRealm; import org.jeecg.modules.shiro.authc.aop.JwtFilter; import org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.DependsOn; /** * @author: Scott * @date: 2018/2/7 * @description: shiro 配置類 */ @Configuration public class ShiroConfig { /** * Filter Chain定義說明 * * 1、一個URL可以配置多個Filter,使用逗號分隔 * 2、當(dāng)設(shè)置多個過濾器時,全部驗證通過,才視為通過 * 3、部分過濾器可指定參數(shù),如perms,roles */ @Bean("shiroFilter") public ShiroFilterFactoryBean shiroFilter(SecurityManager securityManager) { ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean(); shiroFilterFactoryBean.setSecurityManager(securityManager); // 攔截器 MapfilterChainDefinitionMap = new LinkedHashMap (); // 配置不會被攔截的鏈接 順序判斷 filterChainDefinitionMap.put("/hello/**", "anon"); //測試新添加的module,不帶token訪問 filterChainDefinitionMap.put("/sys/login", "anon"); //登錄接口排除 filterChainDefinitionMap.put("/sys/getEncryptedString", "anon"); //獲取加密串 filterChainDefinitionMap.put("/sys/sms", "anon");//短信驗證碼 filterChainDefinitionMap.put("/sys/phoneLogin", "anon");//手機(jī)登錄 filterChainDefinitionMap.put("/sys/user/checkOnlyUser", "anon");//校驗用戶是否存在 filterChainDefinitionMap.put("/sys/user/register", "anon");//用戶注冊 filterChainDefinitionMap.put("/sys/user/querySysUser", "anon");//根據(jù)手機(jī)號獲取用戶信息 filterChainDefinitionMap.put("/sys/user/phoneVerification", "anon");//用戶忘記密碼驗證手機(jī)號 filterChainDefinitionMap.put("/sys/user/passwordChange", "anon");//用戶更改密碼 filterChainDefinitionMap.put("/auth/2step-code", "anon");//登錄驗證碼 filterChainDefinitionMap.put("/sys/common/view/**", "anon");//圖片預(yù)覽不限制token filterChainDefinitionMap.put("/sys/common/download/**", "anon");//文件下載不限制token filterChainDefinitionMap.put("/sys/common/pdf/**", "anon");//pdf預(yù)覽 filterChainDefinitionMap.put("/generic/**", "anon");//pdf預(yù)覽需要文件 filterChainDefinitionMap.put("/", "anon"); filterChainDefinitionMap.put("/doc.html", "anon"); filterChainDefinitionMap.put("/**/*.js", "anon"); filterChainDefinitionMap.put("/**/*.css", "anon"); filterChainDefinitionMap.put("/**/*.html", "anon"); filterChainDefinitionMap.put("/**/*.svg", "anon"); filterChainDefinitionMap.put("/**/*.jpg", "anon"); filterChainDefinitionMap.put("/**/*.png", "anon"); filterChainDefinitionMap.put("/**/*.ico", "anon"); filterChainDefinitionMap.put("/druid/**", "anon"); filterChainDefinitionMap.put("/swagger-ui.html", "anon"); filterChainDefinitionMap.put("/swagger**/**", "anon"); filterChainDefinitionMap.put("/webjars/**", "anon"); filterChainDefinitionMap.put("/v2/**", "anon"); //性能監(jiān)控 filterChainDefinitionMap.put("/actuator/metrics/**", "anon"); filterChainDefinitionMap.put("/actuator/httptrace/**", "anon"); filterChainDefinitionMap.put("/actuator/redis/**", "anon"); //表單設(shè)計器 filterChainDefinitionMap.put("/desform/**", "anon"); //自定義表單 filterChainDefinitionMap.put("/test/jeecgDemo/demo3", "anon"); //模板測試 filterChainDefinitionMap.put("/test/jeecgDemo/redisDemo/**", "anon"); //redis測試 //流程模塊組件請求 filterChainDefinitionMap.put("/act/process/**", "anon"); filterChainDefinitionMap.put("/act/task/**", "anon"); filterChainDefinitionMap.put("/act/model/**", "anon"); filterChainDefinitionMap.put("/service/editor/**", "anon"); filterChainDefinitionMap.put("/service/model/**", "anon"); filterChainDefinitionMap.put("/service/model/**/save", "anon"); filterChainDefinitionMap.put("/editor-app/**", "anon"); filterChainDefinitionMap.put("/diagram-viewer/**", "anon"); filterChainDefinitionMap.put("/modeler.html", "anon"); filterChainDefinitionMap.put("/designer", "anon"); filterChainDefinitionMap.put("/designer/**", "anon"); filterChainDefinitionMap.put("/plug-in/**", "anon"); //排除Online請求 filterChainDefinitionMap.put("/auto/cgform/**", "anon"); //FineReport報表 filterChainDefinitionMap.put("/ReportServer**", "anon"); // 添加自己的過濾器并且取名為jwt Map filterMap = new HashMap (1); filterMap.put("jwt", new JwtFilter()); shiroFilterFactoryBean.setFilters(filterMap); //