瑞吉外卖项目学习条记(二)Swagger、logback、表单校验和参数打印功能的实现

瑞吉外卖项目学习条记(一)准备工作、员工登录功能实现

  
3 项目组件优化

3.1 实现Swagger文档输出

  

• 1）在application.yml中增长knife4j设置
  

1. spring:
2.   mvc:
3.     pathmatch:
4.       matching-strategy: ANT_PATH_MATCHER
5. knife4j:
6.   enable: true
7.   title: 瑞吉外卖
8.   group: ruiji_takeout
9.   description: 瑞吉外卖
10.   version: 1.0
11.   name: itweid
12.   url:
13.   email:
14.   base-package: com.itweid.takeout.controller

复制代码

  

• 2）创创建置类SwaggerProperties类吸取设置
  

1. @Data
2. @ConfigurationProperties(prefix = "knife4j")
3. public class SwaggerProperties {
4.    
5.    
7.     private String title = ""; //标题
8.     private String group = ""; //组名
9.     private String description = ""; //描述
10.     private String version = ""; //版本
11.     private String name = ""; // 联系人
12.     private String url = ""; // 联系人url
13.     private String email = ""; // 联系人email
14.     private String basePackage = ""; //swagger会解析的包路径
15.     private List<String> basePath = new ArrayList<>(); //swagger会解析的url规则
16.     private List<String> excludePath = new ArrayList<>(); //在basePath基础上需要排除的url
17.     // 如果没有填写组名，则直接用标题作为组名
18.     public String getGroup() {
19.    
20.    
21.         if (group == null || group.isEmpty()) {
22.    
23.    
24.             return title;
25.         }
26.         return group;
27.     }
28. }

复制代码

  

• 3）创建自动设置类SwaggerAutoConfiguration举行初始化
  

1. @Configuration
2. @ConditionalOnProperty(name = "knife4j.enable", havingValue = "true", matchIfMissing = true)
3. @EnableSwagger2
4. @EnableConfigurationProperties(SwaggerProperties.class)
5. public class SwaggerAutoConfiguration implements BeanFactoryAware {
6.    
7.    
9.     @Autowired
10.     private SwaggerProperties swaggerProperties;
11.     @Autowired
12.     private BeanFactory beanFactory;
14.     @Bean
15.     @ConditionalOnMissingBean
16.     public List<Docket> createRestApi(){
17.    
18.    
19.         ConfigurableBeanFactory configurableBeanFactory = (ConfigurableBeanFactory) beanFactory;
20.         List<Docket> docketList = new LinkedList<>();
21.         ApiInfo apiInfo = new ApiInfoBuilder()
22.                 // 页面标题
23.                 .title(swaggerProperties.getTitle())
24.                 // 创建人
25.                 .contact(new Contact(swaggerProperties.getName(),
26.                         swaggerProperties.getUrl(),
27.                         swaggerProperties.getEmail()))
28.                 // 版本号
29.                 .version(swaggerProperties.getVersion())
30.                 // 描述
31.                 .description(swaggerProperties.getDescription())
32.                 .build();
33.         Docket docket = new Docket(DocumentationType.SWAGGER_2)
34.                 .apiInfo(apiInfo)
35.                 .groupName(swaggerProperties.getGroup())
36.                 .select()
37.                 // 为当前包路径
38.                 .apis(RequestHandlerSelectors.

复制代码