当前位置: 首页 > news >正文

项目规范 编写规范(范例)

项目目录

目录接口参考 项目目录结构设计,增加部分领域模型后缀强制定义,方便统一编码风格。

controller:请求处理 @RestController
module:按大业务区分,对多个业务对象数据聚合处理  @Component
manager:按业务对象区分,对同一业务对象的数据聚合处理 @Component
service:按业务对象区分,主要负责数据获取
 impl:主要负责数据获取的接口的具体实现 @Service
dao:主要负责数据访问层
xxxDao:固定后缀 Dao @Repository
config:配置类集合目录

dto:数据传输协议,用于 module、manager、service之间的数据传输

xxxDTO:固定后缀 DTO

model:持久层数据协议映射

xxxBean:固定后缀 Bean

query:前端请求接收DTO,用于接收及校验参数

xxxQuery:固定后缀 Query
vo:返回前端数据封装视图DTO

xxxVO:固定后缀 VO
component:流程扩展处理模块,如redis操作,aop,过滤器等
utils: 主要负责一些通用工具类的集合目录

resources
mapper
xxxMapper.xml  Mybatis 复杂sql实现,简单sql可用mybatis plus 接口实现

TODO: 项目脚手架

response-starter

1、统一返回封装

{
“statusCode”: 0,
“statusMsg”: “success”,
“data” : null
}
2、自定义异常  BaseException

3、自定义响应码枚举及接口   ResponseEnum DefaultResponseEnum

3、ControllerAdvice 全局异常 处理

/**

  • 自定义异常
  • @param ex 自定义异常 {@link BaseException}
  • @return 返回 200
    */
    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(BaseException.class)
    public BaseResponseVO handleBusException(BaseException ex) {
    return new BaseResponseVO<>(ex.getCode(), ex.getMsg(), ex.getData());
    }

/**

  • 参数校验失败
  • @param e {@link MethodArgumentNotValidException}
  • @return 返回 400
    */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public BaseResponseVO methodArgumentNotValidException(MethodArgumentNotValidException e) {
    ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
    return new BaseResponseVO<>(DefaultResponseEnum.VALIDATE_FAILED, objectError.getDefaultMessage());
    }

/**

  • 未定义异常
  • @param e 异常
  • @return 返回 500
    */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(Exception.class)
    public BaseResponseVO handleException(Exception e) {
    return new BaseResponseVO<>(DefaultResponseEnum.FAIL, e.getMessage());
    }

4、ExceptionControllerAdvice 和 ResponseControllerAdvice 默认关闭,开启方式 application.yml 配置

zixun:
response:
advice-exception-enabled: true
advice-response-body-enabled: true

5、返回对象属性默认为 statusCode 和 statusMsg, 修改方式 application.yml 配置

zixun:
response:
status-code: status_code
status-msg: status_msg

http://www.lryc.cn/news/115292.html

相关文章:

  • MongoDB数据库操作及操作命令
  • Linux命令(62)之tee
  • 搭建Repo服务器
  • 安卓:MMKV——键值存储库
  • 使用Python将图像转换为PDF:一次性解决您的批量转换需求
  • Vue——webpack
  • springboot房地产管理java购房租房二手房j客户sp源代码mysql
  • Gartner 发布影响数据科学和机器学习未来方向重要趋势
  • 72. 编辑距离
  • Android12.0 原生系统SystemUI下拉状态栏和通知栏视图之锁屏通知布局
  • 周末在家值班,解决几个月前遗忘的Bug
  • Shell编程基础(十五)文本三剑客(sed)
  • 5,二叉树【p6-p7】
  • 【Spring】如果你需要使用重试机制,请使用Spring官方的Spring Retry
  • pagehelper 优化自定义分页和排序位置
  • Linux下查询文件夹中文件数量的方法
  • PS透明屏,在科技展示中,有哪些优点展示?
  • Hbase-面试题
  • 图的宽度优先深度优先遍历
  • redis Set类型命令
  • Netty框架自带类DefaultEventExecutorGroup的作用,用来做业务的并发
  • TCP的四次挥手与TCP状态转换
  • 【网络编程】实现一个简单多线程版本TCP服务器(附源码)
  • centos离线部署docker
  • ffmpeg使用滤镜对视频进行处理播放
  • Ansible Handlers模块详解,深入理解Ansible Handlers 自动化中的关键组件
  • threejs点击模型实现模型边缘高亮的选中效果--更改后提高帧率
  • RocketMQ 主备自动切换模式部署
  • 【MySQL】select相关
  • 在Python中应用RSA算法实现图像加密:基于Jupyter环境的详细步骤和示例代码