Springboot整合knife4j與shiro的操作
一、介紹knife4j
增強(qiáng)版本的Swagger 前端UI,取名knife4j是希望她能像一把匕首一樣小巧,輕量,并且功能強(qiáng)悍,更名也是希望把她做成一個(gè)為Swagger接口文檔服務(wù)的通用性解決方案,不僅僅只是專注于前端Ui前端。
二、Spring Boot 整合knife4j
第一步
在Maven中的pom.xml文件引入:
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<!--在引用時(shí)請(qǐng)?jiān)趍aven中央倉庫搜索最新版本號(hào)-->
<version>2.0.4</version>
</dependency>
第二步
增加配置類,主要添加@Configuration、EnableSwagger2、@EnableKnife4j以及@Import(BeanValidatorPluginsConfiguration.class)注解:
@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class Swagger2Config {
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.enable(true)
.select()
//為當(dāng)前包下controller生成API文檔
.apis(RequestHandlerSelectors.basePackage("com.dream"))
.paths(PathSelectors.any())
.build()
.securitySchemes(securitySchemes())
.securityContexts(securityContexts());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("SwaggerUI")
.description("mall-tiny")
.contact("macro")
.version("1.0")
.build();
}
private List<ApiKey> securitySchemes() {
//設(shè)置請(qǐng)求頭信息
List<ApiKey> result = new ArrayList<>();
ApiKey apiKey = new ApiKey("Authorization", "Authorization", "header");
result.add(apiKey);
return result;
}
private List<SecurityContext> securityContexts() {
//設(shè)置需要登錄認(rèn)證的路徑
List<SecurityContext> result = new ArrayList<>();
result.add(getContextByPath("/misty/.*"));
return result;
}
private SecurityContext getContextByPath(String pathRegex){
return SecurityContext.builder()
.securityReferences(defaultAuth())
.forPaths(PathSelectors.regex(pathRegex))
.build();
}
private List<SecurityReference> defaultAuth() {
List<SecurityReference> result = new ArrayList<>();
AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
result.add(new SecurityReference("Authorization", authorizationScopes));
return result;
}
}
第三步
如果項(xiàng)目中沒有使用shiro、SpringSecurity 等權(quán)限框架,可以訪問,如下地址:
http://localhost:8080/doc.html
第四步
如果使用了權(quán)限框架,如shiro、SpringSecurity,需要添加配置:
1、實(shí)現(xiàn)WebMvcConfigurer
@SpringBootApplication
public class SwaggerBootstrapUiDemoApplication implements WebMvcConfigurer{
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("doc.html").addResourceLocations("classpath*:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath*:/META-INF/resources/webjars/");
}
}
注意: 樓主在這里遇到一個(gè)很大的坑,就是如果我使用classpath*:,會(huì)一直報(bào)錯(cuò);修改為classpath后,恢復(fù)正常。
2、樓主用的shiro,需要配置,放開相應(yīng)的路徑:
@Bean
protected ShiroFilterChainDefinition shiroFilterChainDefinition() {
DefaultShiroFilterChainDefinition chainDefinition = new DefaultShiroFilterChainDefinition();
chainDefinition.addPathDefinition("/doc.html", "anon");
chainDefinition.addPathDefinition("/webjars/**/**", "anon");
return chainDefinition;
}
第五步,展示結(jié)果:
首頁

實(shí)體頁

補(bǔ)充一點(diǎn)知識(shí):
classpath和classpath*區(qū)別:
- classpath:默認(rèn)只會(huì)在你項(xiàng)目的class路徑中查找文件。
- classpath*:默認(rèn)不僅包含class路徑,還包括jar文件中(class路徑)進(jìn)行查找。
- 注意:
- 使用classpath*:Spring需要遍歷所有的classpath,所以加載速度是很慢的;故在設(shè)計(jì)中,應(yīng)該盡可能劃分好資源文件所在的路徑,盡量避免使用classpath*。
classpath*的使用:
- 當(dāng)項(xiàng)目中有多個(gè)classpath路徑,并同時(shí)加載多個(gè)classpath路徑下(此種情況多數(shù)不會(huì)遇到)的文件,就發(fā)揮了作用,如果不加,則表示僅僅加載第一個(gè)classpath路徑。
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
java對(duì)象對(duì)比之comparable和comparator的區(qū)別
今天給大家?guī)淼氖顷P(guān)于Java的相關(guān)知識(shí),文章圍繞著comparable和comparator的區(qū)別展開,文中有非常詳細(xì)的介紹及代碼示例,需要的朋友可以參考下2021-06-06
Java虛擬機(jī)執(zhí)行引擎知識(shí)總結(jié)
這篇文章主要介紹了有關(guān)Java虛擬機(jī)執(zhí)行引擎的知識(shí),文中實(shí)例簡單易懂,方便大家更好的學(xué)習(xí),有興趣的朋友可以了解下2020-06-06
java使用this調(diào)用構(gòu)造函數(shù)的實(shí)現(xiàn)方法示例
這篇文章主要介紹了java使用this調(diào)用構(gòu)造函數(shù)的實(shí)現(xiàn)方法,結(jié)合實(shí)例形式分析了java面向?qū)ο蟪绦蛟O(shè)計(jì)中函數(shù)調(diào)用相關(guān)操作技巧,需要的朋友可以參考下2019-08-08
Java中的 FilterInputStream簡介_動(dòng)力節(jié)點(diǎn)Java學(xué)院整理
FilterInputStream 的作用是用來“封裝其它的輸入流,并為它們提供額外的功能”。接下來通過本文給大家分享Java中的 FilterInputStream簡介,感興趣的朋友一起學(xué)習(xí)吧2017-05-05
Java數(shù)據(jù)結(jié)構(gòu)與算法之稀疏數(shù)組與隊(duì)列深入理解
這篇文章主要介紹了Java數(shù)據(jù)結(jié)構(gòu)與算法之稀疏數(shù)組與隊(duì)列深入理解,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-09-09
SpringBoot整合Prometheus如何實(shí)現(xiàn)資源監(jiān)控
本文介紹了如何使用Prometheus監(jiān)控SpringBoot應(yīng)用,Prometheus是一個(gè)開源的監(jiān)控和告警工具,SpringBootActuator提供了監(jiān)控和管理SpringBoot應(yīng)用的工具,通過添加依賴、配置Actuator和Prometheus,可以實(shí)現(xiàn)對(duì)SpringBoot應(yīng)用的實(shí)時(shí)監(jiān)控2024-12-12

