Springboot的项目如何分层

代码小郭

已于 2023-07-19 16:05:14 修改

阅读量818

点赞数 1

分类专栏：个人博客文章文章标签： spring boot 后端 java

于 2023-07-19 11:22:58 首次发布

本文链接：https://blog.csdn.net/u011208987/article/details/131804729

版权

个人博客文章专栏收录该内容

17 篇文章 0 订阅

订阅专栏

Springboot的项目分层

个人博客：www.gydblog.com

每个人、每个开发团队的规范习惯都不太一样，没有固定标准，合适的才是最好的。这里记录下我习惯的一种springboot项目分层方式

初学时简单分层-单个module

初学时一般都是一些简单项目，单个module即可满足需求，该module内划分如下：

在这里插入图片描述

controller层

controller层是用来接受前端提交的数据并调用一个或多个service层接口执行，返回请求结果的。该层一般不能包含任何业务处理逻辑，通常在该层做一些系统级别的参数校验、鉴权、限流、入参出参打印、耗时统计等切面拦截。 controller层应该只是一个转发者，不能包含太重的处理逻辑！


@RestController
@RequestMapping("/api")
public class ApiController {
 
    @Autowired
    private ApiService apiService;
    
    @GetMapping("/select")
    public List<String> index(){
        return apiService.query();
    }
 
    @PostMapping("/insert")
    public boolean save(@RequestBody String data){
        return apiService.save(data);
    }
 
    @DeleteMapping("/{id}")
    public Integer delete(@PathVariable Integer id){
        return apiService.deleteById(id);
    } 
}

service层

service层接收controller层的请求参数，并实现具体的业务复杂逻辑，service层也会调用多个mapper层与数据库进行交互，或者调用其他依赖服务进行数据的增删改查操作。一个controller层会对应多个service层的具体实现。

public class ApiServiceImpl extends ApiService {
    @Autowired
    private ApiMapper mapper;

        public boolean save(String data) {
            if(data == "1"){
            return mapper.save(user);//mapper层的实现 
            }else{
            return mapper.update(data);
        }
}

mapper层

mapper层是持久化层，负责和数据库进行交互，定义了具体的增删改查sql。在mybatis中mapper方法主要与与xxx.xml内相互一一映射。

@Mapper
public interface ApiMapper extends BaseMapper<String> {//数据库查询接口，专门用来跟数据库交互用的
    @Select("SELECT xx from api_data")
    public List<String> findAll();
 
    List<User> findAll1();
    @Insert("INSERT into api_data(xx)VALUES(#{data};")
    public int insert(String data);
 
    public int update(String data);
 
    @Delete("delete from api_data where id = #{id}")
    public Integer deleteById(@Param("id") Integer id);

entity层

entity层创建实体类，和数据库表里面属性值一一对应。实现set和get的方法。

@Data//Data注解代替了get和set方法
@TableName(value = "table_xxx")
public class DataEntity {
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String data;
}

dto层

dto层主要负责定义服务之间交互的实体类，大部分情况下和entity层保持一致。也会存在一些聚合结构或者字段转换后的定义，主要用于业务处理后生成的数据结构定义或者服务与服务之间接口传输参数的定义, 有时候也会直接返回给前端用于展示

@Data//Data注解代替了get和set方法
public class DataDto {
    private Integer id;
    private String data;
}

vo层

vo层主要负责定义前端展示的实体结构，一般是通过dto转换而来，非必须存在，我认为只要存在dto和vo结构一模一样时，就不需要定义一个多余的vo对象了，可以直接用dto替代vo返回给到前端。

@Data//Data注解代替了get和set方法
public class DataVo {
    private Integer id;
    private String data;
}

validator层

validator层主要用于校验参数，参数分为系统级别参数和业务参数，都统一在这一层做具体实现。能够很好的避免在service层出现大量的ifelse判断。

public class XXXValidator {
    
    public void checkParam(String param) {
        if (null == param){
            throw new RuntimeException("参数不能为空");
        }
    }
}

util层

util层主要用于定义各种工具类，如日期操作、数值操作、字符串操作等。

/**
 * 用于高精确处理常用的数学运算
 */
public class ArithmeticUtils {
    //默认除法运算精度
    private static final int DEF_DIV_SCALE = 10;

    /**
     * 提供精确的加法运算
     *
     * @param v1 被加数
     * @param v2 加数
     * @return 两个参数的和
     */

    public static double add(double v1, double v2) {
        BigDecimal b1 = new BigDecimal(Double.toString(v1));
        BigDecimal b2 = new BigDecimal(Double.toString(v2));
        return b1.add(b2).doubleValue();
    }
}

进阶多模块分层-多个module

主要分成以下几层来划分module：

控制层：xxx-controller 
服务层：xxx-service 
数据层：xxx-dao 
门面层：xxx-facade
接口层：xxx-api
工具层：xxx-util 
公共层：xxx-common 
领域层：xxx-domain 
网关层：xxx-gateway 
启动层：xxx-boot