金樱子

首页 » 常识 » 预防 » 一个SpringBoot项目该包含哪
TUhjnbcbe - 2021/4/22 1:31:00

点击上方蓝色“方志朋”,选择“设为星标”

回复“”获取独家整理的学习资料!

小Hub领读:

你会搭建一个springboot项目吗?有哪些点需要注意的?其实都差不多,记住几个流程!

作者:不一样的科技宅

juejin.im/post/

前言

建立一个全新的项目,或者把旧的庞大的项目,进行拆分成多个项目。在建立新的项目中,经常需要做一些重复的工作,比如说拷贝一下常用的工具类,通用代码等等。

所以就可以做一个基础的项目方便使用,在经历新项目的时候,直接在基础项目上进行简单配置就可以开发业务代码了。

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

Swagger在线接口文档。

CodeGenerator代码生成器。

统一返回。

通用的分页对象。

常用工具类。

全局异常拦截。

错误枚举。

自定义异常。

多环境配置文件。

Maven多环境配置。

日志配置。

JenkinsFile。

?

可以在评论区进行补充

?

Swagger

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

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

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

常用的Swagger注解Api用于Controller

ApiOperation用于Controller内的方法。

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

ApiModel用于标识类的名称

ApiModelProperty用于标识属性的名称

案例RestController

Api(tags="用户")

AllArgsConstructor

RequestMapping("/user")publicclassUserController{privateIUserServiceuserService;/***获取用户列表*

paramlistUserForm表单数据*

turn用户列表*/

ApiOperation("获取用户列表")

GetMapping("/listUser")

ApiResponses(

ApiResponse(code=,message="操作成功",sponse=UserVo.class))publicResultVolistUser(

ValidatedListUserFormlistUserForm){turnResultVoUtil.success(userService.listUser(listUserForm));}}

Data

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

EqualsAndHashCode(callSuper=false)publicclassListUserFormextendsPageFormListUserForm{/***用户状态*/

ApiModelProperty("用户状态")

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

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

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

CodeGenerator代码生成器。

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

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

搜索公纵号:MarkerHub,

1
查看完整版本: 一个SpringBoot项目该包含哪