一个 SpringBoot 项目该包含哪些?
阅读本文大概需要 9 分钟。
来自:https://juejin.cn/post/6844904083942277127
前言
基础项目该包含哪些东西。
Swagger在线接口文档。
CodeGenerator 代码生成器。
统一返回。
通用的分页对象。
常用工具类。
全局异常拦截。
错误枚举。
自定义异常。
多环境配置文件。
Maven多环境配置。
日志配置。
JenkinsFile。
可以在评论区进行补充
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<ListUserForm> {
/**
* 用户状态
*/
@ApiModelProperty("用户状态")
@NotEmpty(message = "用户状态不能为空")
@Range(min = -1 , max = 1 , message = "用户状态有误")
private String status;
}复制代码
SwaggerConfiguration.java
.CodeGenerator代码生成器。
entity
,service
,serviceImpl
,mapper
,mapper.xml
。省去了建立一大堆实体类的麻烦。CodeGenerator.java
.常用的封装
统一返回 ResultVo
@Data
@ApiModel("固定返回格式")
public class ResultVo {
/**
* 错误码
*/
@ApiModelProperty("错误码")
private Integer code;
/**
* 提示信息
*/
@ApiModelProperty("提示信息")
private String message;
/**
* 具体的内容
*/
@ApiModelProperty("响应数据")
private Object data;
}复制代码
抽象表单 BaseForm
public abstract class BaseForm<T> {
/**
* 获取实例
* @return 返回实体类
*/
public abstract T buildEntity();
}复制代码
/**
* 添加用户
* @param userForm 表单数据
* @return true 或者 false
*/
@Override
public boolean addUser(AddUserForm userForm) {
User user = new User();
user.setNickname(userForm.getNickname());
user.setBirthday(userForm.getBirthday());
user.setUsername(userForm.getUsername());
user.setPassword(userForm.getPassword());
return save(user);
}复制代码
/**
* 添加用户
* @param userForm 表单数据
* @return true 或者 false
*/
@Override
public boolean addUser(AddUserForm userForm) {
User user = new User();
BeanUtils.copyProperties(this,user);
return save(user);
}复制代码
@Data
@EqualsAndHashCode(callSuper = false)
public class AddUserForm extends BaseForm<User> {
/**
* 昵称
*/
private String nickname;
/**
* 生日
*/
private Date birthday;
/**
* 用户名
*/
private String username;
/**
* 密码
*/
private String password;
/**
* 构造实体
* @return 实体对象
*/
@Override
public User buildEntity() {
User user = new User();
BeanUtils.copyProperties(this,user);
return user;
}
}复制代码
/**
* 添加用户
* @param userForm 表单数据
* @return true 或者 false
*/
@Override
public boolean addUser(AddUserForm userForm) {
return save(userForm.buildEntity());
}复制代码
form
可以继承baseform
并实现buildEntity()
这样可以更加符合面向对象,service
不需要关心form
如何转变成entity
,只需要在使用的时候调用buildEntity()
即可,尤其是在form
-> entity
相对复杂的时候,这样做可以减少service
内的代码。让代码逻辑看起来更加清晰。通用的分页对象
PageForm.calcCurrent()
、PageVo.setCurrentAndSize()
、PageVo.setTotal()
这个几个方法。PageForm
@Data
@ApiModel(value = "分页数据", description = "分页需要的表单数据")
public class PageForm<T extends PageForm>>{
/**
* 页码
*/
@ApiModelProperty(value = "页码 从第一页开始 1")
@Min(value = 1, message = "页码输入有误")
private Integer current;
/**
* 每页显示的数量
*/
@ApiModelProperty(value = "每页显示的数量 范围在1~100")
@Range(min = 1, max = 100, message = "每页显示的数量输入有误")
private Integer size;
/**
* 计算当前页 ,方便mysql 进行分页查询
* @return 返回 pageForm
*/
@ApiModelProperty(hidden = true)
public T calcCurrent(){
current = (current - 1 ) * size;
return (T) this;
}
}复制代码
PageVo
@Data
public class PageVo<T> {
/**
* 分页数据
*/
@ApiModelProperty(value = "分页数据")
private Listrecords;
/**
* 总条数
*/
@ApiModelProperty(value = "总条数")
private Integer total;
/**
* 总页数
*/
@ApiModelProperty(value = "总页数")
private Integer pages;
/**
* 当前页
*/
@ApiModelProperty(value = "当前页")
private Integer current;
/**
* 查询数量
*/
@ApiModelProperty(value = "查询数量")
private Integer size;
/**
* 设置当前页和每页显示的数量
* @param pageForm 分页表单
* @return 返回分页信息
*/
@ApiModelProperty(hidden = true)
public PageVosetCurrentAndSize(PageForm> pageForm) {
BeanUtils.copyProperties(pageForm,this);
return this;
}
/**
* 设置总记录数
* @param total 总记录数
*/
@ApiModelProperty(hidden = true)
public void setTotal(Integer total) {
this.total = total;
this.setPages(this.total % this.size > 0 ? this.total / this.size + 1 : this.total / this.size);
}
}复制代码
案例
ListUserForm
@Data
@ApiModel("获取用户列表需要的表单数据")
@EqualsAndHashCode(callSuper = false)
public class ListUserForm extends PageForm<ListUserForm> {
/**
* 用户状态
*/
@ApiModelProperty("用户状态")
@NotEmpty(message = "用户状态不能为空")
@Range(min = -1 , max = 1 , message = "用户状态有误")
private String status;
}复制代码
UserServiceImpl
/**
* 获取用户列表
* @param listUserForm 表单数据
* @return 用户列表
*/
@Override
public PageVolistUser(ListUserForm listUserForm) {
PageVopageVo = new PageVo ().setCurrentAndSize(listUserForm);
pageVo.setTotal(countUser(listUserForm.getStatus()));
pageVo.setRecords(userMapper.listUser(listUserForm.calcCurrent()));
return pageVo;
}
/**
* 获取用户数量
* @param status 状态
* @return 用户数量
*/
private Integer countUser(String status){
return count(new QueryWrapper().eq("status",status));
}复制代码
UserController
/**
* 获取用户列表
* @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));
}复制代码
注意的点
PageVo在实例化的时候需要设置当前页和每页显示的数量 可以调用
setCurrentAndSize()
完成。进行分页查询的时候,需要计算偏移量。
listUserForm.calcCurrent()
假如查询第1页每页显示10条记录,前端传递过来的参数是
current=1&&size=10
,这个时候limit 1,10
没有问题。假如查询第2页每页显示10条记录,前端传递过来的参数是
current=2&&size=10
,这个时候limit 2,10
就有问题,实际应该是limit 10,10
。calcCurrent()的作用就是如此
。
自带的分页查询在大量数据下,会出现性能问题。
常用工具类
异常处理
异常信息抛出 ->
ControllerAdvice
进行捕获格式化输出内容手动抛出
CustomException
并传入ReulstEnum
——> 进行捕获错误信息输出错误信息。
自定义异常
@Data
@EqualsAndHashCode(callSuper = false)
public class CustomException extends RuntimeException {
/**
* 状态码
*/
private final Integer code;
/**
* 方法名称
*/
private final String method;
/**
* 自定义异常
*
* @param resultEnum 返回枚举对象
* @param method 方法
*/
public CustomException(ResultEnum resultEnum, String method) {
super(resultEnum.getMsg());
this.code = resultEnum.getCode();
this.method = method;
}
/**
* @param code 状态码
* @param message 错误信息
* @param method 方法
*/
public CustomException(Integer code, String message, String method) {
super(message);
this.code = code;
this.method = method;
}
}复制代码
错误信息枚举
@Getter
public enum ResultEnum {
/**
* 未知异常
*/
UNKNOWN_EXCEPTION(100, "未知异常"),
/**
* 添加失败
*/
ADD_ERROR(103, "添加失败"),
/**
* 更新失败
*/
UPDATE_ERROR(104, "更新失败"),
/**
* 删除失败
*/
DELETE_ERROR(105, "删除失败"),
/**
* 查找失败
*/
GET_ERROR(106, "查找失败"),
;
private Integer code;
private String msg;
ResultEnum(Integer code, String msg) {
this.code = code;
this.msg = msg;
}
/**
* 通过状态码获取枚举对象
* @param code 状态码
* @return 枚举对象
*/
public static ResultEnum getByCode(int code){
for (ResultEnum resultEnum : ResultEnum.values()) {
if(code == resultEnum.getCode()){
return resultEnum;
}
}
return null;
}
}复制代码
全局异常拦截
@ControllerAdvice
进行实现,常用的异常拦截配置可以查看 GlobalExceptionHandling。@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandling {
/**
* 自定义异常
*/
@ExceptionHandler(value = CustomException.class)
public ResultVo processException(CustomException e) {
log.error("位置:{} -> 错误信息:{}", e.getMethod() ,e.getLocalizedMessage());
return ResultVoUtil.error(Objects.requireNonNull(ResultEnum.getByCode(e.getCode())));
}
/**
* 通用异常
*/
@ResponseStatus(HttpStatus.OK)
@ExceptionHandler(Exception.class)
public ResultVo exception(Exception e) {
e.printStackTrace();
return ResultVoUtil.error(ResultEnum.UNKNOWN_EXCEPTION);
}
}复制代码
案例
Controller
/**
* 删除用户
* @param id 用户编号
* @return 成功或者失败
*/
@ApiOperation("删除用户")
@DeleteMapping("/deleteUser/{id}")
public ResultVo deleteUser(@PathVariable("id") String id){
userService.deleteUser(id);
return ResultVoUtil.success();
}复制代码
Service
/**
* 删除用户
* @param id id
*/
@Override
public void deleteUser(String id) {
// 如果删除失败抛出异常。 -- 演示而已不推荐这样干
if(!removeById(id)){
throw new CustomException(ResultEnum.DELETE_ERROR, MethodUtil.getLineInfo());
}
}复制代码
结果
注意的点
ResultEnum
进行统一维护。不同的业务使用不同的错误码。方便在报错时进行分辨。快速定位问题。多环境配置
SpringBoot多环境配置
dev
,test
,pre
,prod
,对于SpringBoot项目多建立几个配置文件就可以了。然后启动的时候可以通过配置spring.profiles.active
来选择启动的环境。java -jar BasicProject.jar --spring.profiles.active=prod 复制代码
Maven多环境配置
配置XML
<profiles>
<profile>
<id>devid>
<activation>
<activeByDefault>trueactiveByDefault>
activation>
<properties>
<activatedProperties>devactivatedProperties>
properties>
profile>
<profile>
<id>testid>
<properties>
<activatedProperties>testactivatedProperties>
properties>
profile>
<profile>
<id>preid>
<properties>
<activatedProperties>preactivatedProperties>
properties>
profile>
<profile>
<id>prodid>
<properties>
<activatedProperties>prodactivatedProperties>
properties>
profile>
profiles>复制代码
更改application.yml
spring:
profiles:
# 选择环境
active: @activatedProperties@复制代码
使用案例
mvn clean package -P prod
mvn clean package -P pre
mvn clean package -P test复制代码
application.yml
会发现spring.profiles.active=@activatedProperties@
发生了改变。日志配置
JenkinsFile
代码地址
https://gitee.com/huangxunhui/basic_project.git
慢一点才能更快
推荐阅读:
微信扫描二维码,关注我的公众号
朕已阅
评论