杨桐的通用开发脚手架——后端代码（Java版本）
-
版本和依赖控制
Maven 3.9.6，层级如下
your-project/ ├── pom.xml ├── src/ │ ├── main/ │ │ ├── java/ │ │ │ └── com/ │ │ │ └── yourcompany/ │ │ │ └── yourapp/ │ │ └── resources/ │ └── test/ │ ├── java/ │ │ └── com/ │ │ └── yourcompany/ │ │ └── yourapp/ │ └── resources/
-
JDK21
至少要使用JDK17及以上的版本
-
Spring-Boot 3.4.4
截止2025-04-04，最新的SpringBoot稳定版本
在父POM中引入以下依赖，子工程就可以直接使用
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>3.4.4</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement>
-
MyBatis-Plus
https://baomidou.com/introduce/
数据库操作库，基于MyBatis
<!--仅适用于SpringBoot3版本的MyBatis-Plus--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-spring-boot3-starter</artifactId> <version>3.5.11</version> </dependency>
-
数据库驱动依赖（MySQL）
<dependency> <groupId>com.mysql</groupId> <artifactId>mysql-connector-j</artifactId> <version>8.3.0</version> </dependency>
-
缓存库依赖
Redis
<!--由于使用了SpringBoot的版本控制，所以这里无需指定版本--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency>
caffeine，基于JVM内存的缓存库
<dependency> <groupId>com.github.ben-manes.caffeine</groupId> <artifactId>caffeine</artifactId> <version>3.0.3</version> </dependency>
-
工具库
Guava
<dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>33.4.6-jre</version> </dependency>
-
单元测试
junit
<dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <scope>test</scope> </dependency>
-
接口文档
使用SpringDoc
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId> <version>4.4.0</version> </dependency>
-
OFFICE操作库
POI，可能跟其他库比如easyexcel，poi-tl等产生版本冲突
<!--poi相关依赖--> <!--处理03版本office--> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>5.2.5</version> </dependency> <!--处理07版本office--> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml</artifactId> <version>5.2.5</version> <exclusions> <exclusion> <groupId>org.apache.commons</groupId> <artifactId>commons-compress</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-compress</artifactId> <version>1.26.0</version> </dependency> <!--处理数据量大的office依赖--> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml-schemas</artifactId> <version>4.1.2</version> </dependency>
为了方便版本控制，以上所有依赖版本最好在父POM中的
properties标签里面统一管理父POM中的其他内容如下：
<!--构建项目的行为--> <build> <plugins> <plugin> <!--maven编译插件--> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.13.0</version> <configuration> <!--源代码的jdk版本--> <source>${java.version}</source> <!--需要生成的目标class文件的编译版本--> <target>${java.version}</target> <!--使用release代替source和target--> <release>${java.version}</release> <!--字符集编码--> <encoding>${project.build.sourceEncoding}</encoding> <!--跳过测试--> <skip>true</skip> <!--是否运行一个独立的进程来执行编译任务--> <fork>true</fork> <compilerArgs> <arg>-parameters</arg> </compilerArgs> </configuration> </plugin> <!--该插件可以使打包扫描文件时，指定后缀名的文件不会被扫描，也就不会被损坏--> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-resources-plugin</artifactId> <version>3.3.1</version> <configuration> <encoding>${project.build.sourceEncoding}</encoding> <nonFilteredFileExtensions> <nonFilteredFileExtension>xlsx</nonFilteredFileExtension> <nonFilteredFileExtension>xls</nonFilteredFileExtension> <nonFilteredFileExtension>doc</nonFilteredFileExtension> <nonFilteredFileExtension>docx</nonFilteredFileExtension> <nonFilteredFileExtension>jpg</nonFilteredFileExtension> <nonFilteredFileExtension>png</nonFilteredFileExtension> </nonFilteredFileExtensions> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>3.2.5</version> <configuration> <skip>true</skip> </configuration> </plugin> </plugins> <!--打包时对不同目录下的文件处理方式--> <resources> <resource> <!--指定目录--> <directory>src/main/java</directory> <!--includes表示打包时除了默认的文件，还应该额外包含的文件--> <includes> <include>**/*.xml</include> </includes> <!--excludes表示打包时应该排除的文件--> <!--<excludes></excludes>--> <!--filtering表示该目录下的文件，是否可以使用maven的profiles定义的变量--> <filtering>false</filtering> </resource> <resource> <directory>src/main/resources</directory> <includes> <!--打包时应包含该目录下的所有文件--> <include>**/*.*</include> </includes> <!--打包时会扫描该目录下的文件，将文件中的占位符@xxx@替换为profiles中配置的环境变量--> <!--扫描excel等文件时，可能造成文件损坏，而这些文件也不需要被扫描，所以需要配置额外的插件排除不需要扫描的文件，如上--> <filtering>true</filtering> </resource> </resources> </build> <!--环境配置, profile标签里面可以填pom文件中的所有内容，方便对不同环境做定制化处理--> <profiles> <!--开发环境--> <profile> <id>dev</id> <!--激活该环境的条件--> <activation> <!--默认环境--> <activeByDefault>true</activeByDefault> </activation> <!--这里配置的变量，能够在spring的配置文件中引用--> <properties> <!--当前环境--> <profile.env>dev</profile.env> </properties> </profile> <!--测试环境--> <profile> <id>test</id> <!--这里配置的变量，能够在spring的配置文件中引用--> <properties> <!--当前环境--> <profile.env>test</profile.env> </properties> </profile> <!--生产环境--> <profile> <id>prod</id> <!--这里配置的变量，能够在spring的配置文件中引用--> <properties> <!--当前环境--> <profile.env>prod</profile.env> </properties> </profile> </profiles>
项目整体结构
parent-project/
├── common/ #基础模块，包含工具栏，基础依赖等不含有web配置的代码，该模块在任何环境下都可单独使用
├── core/ #核心模块，包含SpringBoot项目的配置，只能在SpringBoot环境下使用
├── system/ #业务模块，使用者可以将自己的业务代码写在该模块以下是几个子模块的介绍：
-
common基础模块结构
common/ ├── anno/ #通用注解 ├── cache/ #缓存组件 ├── convert/ #类型转换器组件 ├── enums/ #通用枚举 ├── exception/ #异常相关 ├── holder/ #上下文相关 ├── lock/ #锁相关 ├── model/ #通用类 ├── tree/ #树形操作组件 ├── util/ #工具类
-
core核心模块结构
core/ ├── auth/ #权限校验 ├── listenner/ #监听器 ├── model/ #通用模型 ├── swagger/ #接口文档 ├── util/ #web环境下的工具类
-
system业务模块结构
本系统使用RABC模式来进行权限控制
下面所有表都默认含有基础字段
-
用户表
用户字段
字段 注释 user_name 用户名 real_name 真实姓名 password 密码 avatar 头像 phone 手机号码 email 邮箱 status 状态 birthday 生日 id_card 身份证 depart_code 用户当前部门 -
角色表
角色字段，分为普通角色和部门角色
字段 注释 role_name 角色名称 role_code 角色编码 status 角色状态 depart_code 所属部门，无部门则为空 -
部门表
部门字段
depart_code不能乱填，必须以父部门的depart_code开头
比如父部门的depart_code是A01，那么子部门的depart_code就是A0102
字段 注释 depart_name 部门名称 depart_code 部门编码 pid 上级部门id contact_user_name 部门联系人username address 部门地址 status 状态 -
资源表
资源字段
字段 注释 permission_name 资源名称 permission_code 资源唯一编码 type 资源类型，0-菜单、1-按钮、2-接口 path 地址（菜单路由地址或者接口地址） component 前端组件地址（type为菜单时生效） -
用户-角色表
保存用户和角色的映射关系
字段 注释 user_id 用户id role_id 角色id -
用户-部门表
保存用户和部门的映射关系
字段 注释 user_id 用户id depart_id 部门id -
角色-资源表
字段 注释 role_id 角色id permission_id 资源id
控制哪些人可以看到哪些数据
例如：
-
一个数据只有创建人可以看
-
一个数据只有创建人所在部门下的人可以看
-
一个数据只有指定部门的人能看
-
一个数据只有指定人可以看
-
……
上面的就是数据规则，可以给不同角色配置不同的数据规则，那么切换不同角色时，适用的数据规则也不一样
给一个角色配置了数据规则，那么怎么应用呢？
在接口里获取当前人的角色，然后根据角色去查询数据权限，并组装成SQL片段，然后将SQL片段应用到查询SQL