springboot需要java基础_浅谈一个基础的SpringBoot项目该包含哪些

前言

建立一个全新的项目，或者把旧的庞大的项目，进行拆分成多个项目。在建立新的项目中，经常需要做一些重复的工作，比如说拷贝一下常用的工具类，通用代码等等。所以就可以做一个基础的项目方便使用，在经历新项目的时候，直接在基础项目上进行简单配置就可以开发业务代码了。

基础项目该包含哪些东西。

Swagger在线接口文档。

CodeGenerator 代码生成器。

统一返回。

通用的分页对象。

常用工具类。

全局异常拦截。

错误枚举。

自定义异常。

多环境配置文件。

Maven多环境配置。

日志配置。

JenkinsFile。

Swagger

写接口文档通常是一件比较头疼的事情，然而swagger就用是用来帮我们解决这个问题的。可以在线生成接口文档，并且可以在页面上进行测试。

可以非常清楚的显示，请求数据已经响应数据。当然这一切都需要在代码中进行配置。

注意的点：接口文档只能在测试/开发环境开启，其他环境请关闭。

常用的Swagger注解

@Api用于Controller

@ApiOperation用于Controller内的方法。

@ApiResponses用于标识接口返回数据的类型。

@ApiModel用于标识类的名称

@ApiModelProperty用于标识属性的名称

案例

@RestController

@Api(tags = "用户")

@AllArgsConstructor

@RequestMapping("/user")

public class UserController {

private IUserService userService;

/**

* 获取用户列表

* @param listUserForm 表单数据

* @return 用户列表

*/

@ApiOperation("获取用户列表")

@GetMapping("/listUser")

@ApiResponses(

@ApiResponse(code = 200, message = "操作成功", response = UserVo.class)

)

public ResultVo listUser(@Validated ListUserForm listUserForm){

return ResultVoUtil.success(userService.listUser(listUserForm));

}

}

@Data

@ApiModel("获取用户列表需要的表单数据")

@EqualsAndHashCode(callSuper = false)

public class ListUserForm extends PageForm {

/**

* 用户状态

*/

@ApiModelProperty("用户状态")

@NotEmpty(message = "用户状态不能为空")

@Range(min = -1 , max = 1 , message = "用户状态有误")

private String status;

}

对应的swagger的配置可以查看基础项目内的SwaggerConfiguration.java.

CodeGenerator代码生成器

mybatis_plus代码生成器可以帮我们生成entity,service,serviceImpl,mapper,mapper.xml。省去了建立一大堆实体类的麻烦。

由于配置太长这里就不贴出来了，对应的CodeGenerator的配置可以查看基础项目内的CodeGenerator.java.

常用的封装

统一返回 ResultVo

将所有的接口的响应数据的格式进行统一。

@Data

@ApiModel("固定返回格式")

public class ResultVo {

/**

* 错误码

*/

@ApiModelProperty("错误码")

private Integer code;

/**

* 提示信息

*/

@ApiModelProperty("提示信息")

private String message;

/**

* 具体的内容

*/

@ApiModelProperty("响应数据")

private Object