Java后端开发：SpringBoot项目中的三层架构与代码角色
Posted 夏鹏展
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Java后端开发：SpringBoot项目中的三层架构与代码角色相关的知识，希望对你有一定的参考价值。
一、SpringBoot三层架构
目前，大部分后端项目主要目的是暴露功能接口（API）到网络上，由前端程序访问这些接口并获取数据，然后展示在界面上，它们之间遵从Restful规约；还有一部分项目暴露方法，让前端代码实现远程调用，采用的是RPC的思想。
但是无论如何，后端程序存在的意义就是交换、处理和记录数据。
以下介绍均基于后端项目暴露API。
注：
控制层和服务层的任何一个类都不应该有成员变量，以免造成并发问题。
后端三层架构的任何一个方法都需要考虑方法的健壮性问题，包括入参为空、返回值为空、代码逻辑出错等问题。
1、控制层：Controller
控制层的主要作用是与前端进行交互，即暴露API到网络上，只负责接收数据和返回数据，对数据进行的任何复杂的处理都需要调用Service层的方法。
2、服务层：Service
服务层的主要作用是为了迎合业务需求，写一组方法完成对业务数据进行处理、调用持久化方法等操作。服务层的每一个方法的目的都是为了完成一个不可拆分业务的需求。
3、持久化层：Dao、repository、Mapper
持久化层的主要作用就是为了与数据库交互。例如：实现单表或多表的增删改查。
二、后端代码角色
后端代码角色除了三层架构对应的包和类，还有包括但不限于以下部分：
全局变量(properties、yml)、项目设置类(config)、基础信息类(common)、实体类(entity)、工具类(util)、数据传输类(dto)、异常处理类(exception)
1、全局变量(properties、yml)
全局变量一般以资源文件的形式存放在resource目录下，文件名一般为application.properties或者application.yml。
而且在实际应用中，不同的环境配置不同的文件，例如：上线运行环境名为application-prod.properties、开发和测试环境名为application-dev.properties。上线运行环境中的数据库中的数据一旦修改会造成严重错误，而开发测试环境中的数据是真实数据的一个副本或者假数据。
这些文件中的内容含有数据库连接需要的信息，如username、password、driver、url等；还有当前项目或应用的全局路径和接口，如port、path等；还可以使用Profiles.active指定当前环境的运行环境，但是不建议在这里或者使用@ActiveProfile进行指定，如有需要指定运行环境，可以在启动时添加-Dspring.profiles.active = 指定值。
2、项目设置类(config)
项目配置类一般用来指定当前SpringBoot项目的配置。如：指定扫描路径@ComponentScan等
3、基础信息类(common)
基础信息类的作用是规定API返回的基础信息，如规定返回格式为操作时间，错误信息，数据对象
4、实体类(entity)
实体类的作用是对应数据库中的表，以便于读取和写入，或者使用框架。数据库中的一张表对应一个实体类，一个列名（字段）对应实体类的一个属性，一行对应该类的一个对象。
5、数据传输类(dto)
数据传输类是为了迎合业务需求而创建的类。
与实体类不同的是：
（1）dto一般是多个表组合起来对应的一张表
（2）属性名和数据库列名会有较大不同
（3）实体类用于与数据库交互，dto用于作为参数在不同层级间传输，或者传输到前端
为了迎合业务需求，dto中的属性可能由多个表列名（字段）对应。
为了数据库安全性，dto属性名不应该完全与数据库字段名相似
6、工具类(util)
工具类一般是自己编写的用于数据处理的工具类
如：
（1）为了验证文件正确性，求文件散列值
（2）为了便于处理，将对象转换为Map
（…）等
7、异常处理类(exception)
异常处理类是对异常进行处理的类，是一个自定义的exception类，在任何一个地方都可以抛出并且阻断当前任务。有助于给前端明确的提示信息，并且能够记录错误日志。
Java 之SpringBoot+SpringSecurity+Vue实现后台管理系统的开发二后端
| Java 之SpringBoot+SpringSecurity+Vue实现后台管理系统的开发【一、前端】 | 跳转 |
|---|---|
| Java 之SpringBoot+SpringSecurity+Vue实现后台管理系统的开发【二、后端】 | 跳转 |
| Java 之SpringBoot+SpringSecurity+Vue实现后台管理系统的开发【三、系统权限】 | 跳转 |
一、前言
从零开始搭建一个项目骨架，最好选择合适熟悉的技术，并且在未来易拓展，适合微服务化体系等。所以一般以Springboot作为我们的框架基础，这是离不开的了。
然后数据层，我们常用的是Mybatis，易上手，方便维护。但是单表操作比较困难，特别是添加字段或减少字段的时候，比较繁琐，所以这里我推荐使用Mybatis Plus(https://mp.baomidou.com/)，为简化开发而生，只需简单配置，即可快速进行CRUD操作，从而节省大量时间。
SpringSecurity，使用security作为我们的权限控制和会话控制的框架。
- SpringBoot
- mybatis plus
- spring security
- lombok
- redis
- hibernate validatior
- jwt
二、新建SpringBoot 项目，注意版本
1、新建SpringBoot工程
这里，我们使用IDEA来开发我们项目
开发工具与环境:
idea
mysql
jdk 8
maven3.3.9
新建SpringBoot
删除部分内容
2、整合MyBatis plus，生成代码
（1）引入依赖
<!--整合mybatis plus https://baomidou.com/-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>
<!--mp代码生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
（2）设置配置文件
server:
port: 8081
# DataSource Config
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/zhengadminvue?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shanghai
username: root
password: root
mybatis-plus:
mapper-locations: classpath*:/mapper/**Mapper.xml
新建一个包：通过@mapperScan注解指定要变成实现类的接口所在的包，然后包下面的所有接口在编译之后都会生成相应的实现类。
@Configuration
@ManagedBean("cn.itbluebox.springbootadminvue.mapper")
public class MybatisPlusConfig
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor()
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//分页插件
interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
//防止全表更新插件
interceptor.addInnerInterceptor(new BlockAttackInnerInterceptor());
return interceptor;
@Bean
public ConfigurationCustomizer configurationCustomizer()
return configuration -> configuration.setUseDeprecatedExecutor(false);
创建对应的mapper文件
（3）创建数据库和表
SQL语句
DROP TABLE IF EXISTS `sys_menu`;
CREATE TABLE `sys_menu` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`parent_id` bigint(20) DEFAULT NULL COMMENT '父菜单ID，一级菜单为0',
`name` varchar(64) NOT NULL,
`path` varchar(255) DEFAULT NULL COMMENT '菜单URL',
`perms` varchar(255) DEFAULT NULL COMMENT '授权(多个用逗号分隔，如：user:list,user:create)',
`component` varchar(255) DEFAULT NULL,
`type` int(5) NOT NULL COMMENT '类型 0：目录 1：菜单 2：按钮',
`icon` varchar(32) DEFAULT NULL COMMENT '菜单图标',
`orderNum` int(11) DEFAULT NULL COMMENT '排序',
`created` datetime NOT NULL,
`updated` datetime DEFAULT NULL,
`statu` int(5) NOT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `name` (`name`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=21 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Table structure for sys_role
-- ----------------------------
DROP TABLE IF EXISTS `sys_role`;
CREATE TABLE `sys_role` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`name` varchar(64) NOT NULL,
`code` varchar(64) NOT NULL,
`remark` varchar(64) DEFAULT NULL COMMENT '备注',
`created` datetime DEFAULT NULL,
`updated` datetime DEFAULT NULL,
`statu` int(5) NOT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `name` (`name`) USING BTREE,
UNIQUE KEY `code` (`code`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=8 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Table structure for sys_role_menu
-- ----------------------------
DROP TABLE IF EXISTS `sys_role_menu`;
CREATE TABLE `sys_role_menu` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`role_id` bigint(20) NOT NULL,
`menu_id` bigint(20) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=102 DEFAULT CHARSET=utf8mb4;
-- ----------------------------
-- Table structure for sys_user
-- ----------------------------
DROP TABLE IF EXISTS `sys_user`;
CREATE TABLE `sys_user` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`username` varchar(64) DEFAULT NULL,
`password` varchar(64) DEFAULT NULL,
`avatar` varchar(255) DEFAULT NULL,
`email` varchar(64) DEFAULT NULL,
`city` varchar(64) DEFAULT NULL,
`created` datetime DEFAULT NULL,
`updated` datetime DEFAULT NULL,
`last_login` datetime DEFAULT NULL,
`statu` int(5) NOT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `UK_USERNAME` (`username`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Table structure for sys_user_role
-- ----------------------------
DROP TABLE IF EXISTS `sys_user_role`;
CREATE TABLE `sys_user_role` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`user_id` bigint(20) NOT NULL,
`role_id` bigint(20) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=15 DEFAULT CHARSET=utf8mb4;
（4）代码生成
package cn.itbluebox.springbootadminvue;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator
/**
* <p>
* 读取控制台内容
* </p>
*/
public static String scanner(String tip)
Scanner scanner = new Scanner(System.in);
StringBuilder help = new StringBuilder();
help.append("请输入" + tip + "：");
System.out.println(help.toString());
if (scanner.hasNext())
String ipt = scanner.next();
if (StringUtils.isNotBlank(ipt))
return ipt;
throw new MybatisPlusException("请输入正确的" + tip + "！");
public static void main(String[] args)
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("itbluebox");
gc.setOpen(false);
// gc.setSwagger2(true); 实体属性 Swagger2 注解
gc.setServiceName("%sService");
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/itzheng-vue-admin?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shanghai");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
// pc.setModuleName(scanner("模块名"));
pc.setParent("cn.itbluebox.springbootadminvue");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig()
@Override
public void initMap()
// to do nothing
;
// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 velocity
// String templatePath = "/templates/mapper.xml.vm";
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath)
@Override
public String outputFile(TableInfo tableInfo)
// 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
);
/*
cfg.setFileCreate(new IFileCreate()
@Override
public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath)
// 判断自定义文件夹是否需要创建
checkDir("调用默认方法创建的目录，自定义目录用");
if (fileType == FileType.MAPPER)
// 已经生成 mapper 文件判断存在，不想重新生成返回 false
return !new File(filePath).exists();
// 允许生成模板文件
return true;
);
*/
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
//指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setSuperEntityClass("BaseEntity");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 公共父类
strategy.setSuperControllerClass("BaseController");
// 写于父类中的公共字段
strategy.setSuperEntityColumns("id", "created", "updated", "statu");
strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
// strategy.setTablePrefix("sys_");//动态调整
mpg.setStrategy(strategy);
mpg.以上是关于Java后端开发：SpringBoot项目中的三层架构与代码角色的主要内容，如果未能解决你的问题，请参考以下文章