2022备忘录

1、SpringBoot脚手架

---

• Spring Initializer：https://start.springboot.io/ 、https://start.spring.io/
• 阿里提供的脚手架：https://start.aliyun.com

2、SpringBoot整合Swagger2

---

Swagger的好处：生成在线API文档、测试数据。

1、引入依赖

<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger2artifactId>
    <version>2.9.2version>
dependency>

<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger-uiartifactId>
    <version>2.9.2version>
dependency>

2、编写Swagger配置类

import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2配置类（接口文档）
 *
 * @author 白豆五
 * @version 2022/7/30 19:24
 * @since JDK8
 */
@Configuration  // 配置类
@EnableSwagger2 // 开启Swagger2
public class Swagger2Config {

    /**
     * 配置Swagger插件
     */
    @Bean
    public Docket webApiConfig() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }

    private ApiInfo webApiInfo() {
        return new ApiInfoBuilder()
                .title("网站-API文档")
                .description("本文档描述了xxx管理系统微服务接口定义")
                .version("1.0")
                .contact(new Contact("白豆五", "https://blog.csdn.net/qq_46921028", "[email protected]"))
                .build();
    }
}

3、访问swagger：项目路径/swagger-ui.html

swagger常用注解

1、为实体类（pojo）添加swagger注释：

• @ApiModel("xxxPOJO说明") 作用在模型类上，例如 VO、BO、POJO等等。
• @ApiModelProperty(value = "xxx属性说明",hidden = true) 作用在类方法和属性上，hidden设置为true可以隐藏该属性。

@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@ApiModel("讲师")
public class EduTeacher implements Serializable {

    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "讲师ID")
    @TableId(value = "id", type = IdType.ID_WORKER_STR)
    private String id;

    @ApiModelProperty(value = "讲师姓名")
    private String name;

    @ApiModelProperty(value = "讲师简介")
    private String intro;

    @ApiModelProperty(value = "讲师资历,一句话说明讲师")
    private String career;

    @ApiModelProperty(value = "头衔 1高级讲师 2首席讲师")
    private Integer level;

    @ApiModelProperty(value = "讲师头像")
    private String avatar;

    @ApiModelProperty(value = "排序")
    private Integer sort;

    @ApiModelProperty(value = "逻辑删除 1（true）已删除， 0（false）未删除")
    @TableLogic // 逻辑删除（表中的数据还有，就是不再显示了）
    private Boolean isDeleted;

    @ApiModelProperty(value = "创建时间")
    private Date gmtCreate;

    @ApiModelProperty(value = "更新时间")
    private Date gmtModified;    
}

2、为模块（controller）添加swagger注释：

• @Api(tags = "xxx模块说明") 描述模块类。
• @ApiOperation("xxx接口说明") 描述模块类中的接口方法。
• @ApiParam("xxx参数说明") 描述接口方法的形参。

@Api(tags = "管理员控制器")
@RestController                          // 向页面返回数据 等同于@Controller+@ResponseBody
@RequestMapping("/sms/adminController")  // 请求路径
public class AdminController {

    @Autowired
    private AdminService adminService;

    // GET: /sms/adminController/getAllAdmin/1/3
    @ApiOperation("分页带条件查询管理员信息")
    @GetMapping("/getAllAdmin/{pageNo}/{pageSize}")
    public Result getAllAdmin(
            @ApiParam("页码数") @PathVariable("pageNo") Integer pageNo,
            @ApiParam("页大小") @PathVariable("pageSize") Integer pageSize,
            @ApiParam("管理员名字") String adminName
    ) {
        Page<Admin> pageParm = new Page<>(pageNo, pageSize);
        IPage<Admin> adminPage = adminService.getAdminsByOpr(pageParm, adminName);
        return Result.ok(adminPage);
    }

    // POST: /sms/adminController/saveOrUpdateAdmin student
    @ApiOperation("添加或者修改管理员信息")
    @PostMapping("/saveOrUpdateAdmin")
    public Result addOrUpdateAdmin(
            @ApiParam("JSON的Admin对象") @RequestBody Admin admin //将json字符串转admin对象
    ) {
        Integer id = admin.getId();
        if (id == null || 0 == id) {   //如果是新增要对密码加密
            admin.setPassword(MD5.encrypt(admin.getPassword()));
        }
        adminService.saveOrUpdate(admin);
        return Result.ok();
    }

    // DELETE:  /sms/adminController/deleteAdmin ids[]
    @ApiOperation("删除单个或者多个管理员信息")
    @DeleteMapping("/deleteAdmin")
    public Result deleteAdmin(@ApiParam("要删除管理员信息的JSON集合,接收的是ids[]")  @RequestBody List<Integer> ids) {
        adminService.removeByIds(ids);
        return Result.ok();
    }

}

3、让IntelliJ IDEA 社区版支持Tomcat和SpringBoot

---

方法：在社区版IDEA里下载插件即可

• 支持Tomcat的插件：Smart Tomcat
• 支持SpringBoot的插件：Spring Initializr and Assistant