企业级springboot项目架构模板V3.0，开箱即用

2023-11-03

此次 3.0 更新点：
1.加入文件服务（quick-storage）功能支持OSS、FTP存储（该服务支持以SDK的方式引入）
2.修复sentinel因path路径问题导致流控失效问题
3.修复word模板生成PDF文件工具类时首次生成时，图片生成没有成功写入FTP的问题，原因为临时文件路径问题。
4.修改部分类的包路径
5.auth服务下的各个表结构新增了 serve_name varchar(60) DEFAULT NULL COMMENT ‘所属服务名称’，通过该字段 auth服务可以注入多个项目得用户信息记录，需要在 application-auth.yml 中配置 serve_name和access_key；同时项目启动时会效验sys_serve表中是否存在该服务名称。

介绍

SpringBoot多模块架构，争对企业级开发设计，已集成认证功能、文档功能，开箱即用，并且不同子模块可以配置不同得数据源连接不同数据库，只需要在application-db中添加新的数据库即可（同时登录查看druid监控）。
技术栈： springboot + redis + shiro + swagger
git地址： ~~[https://gitee.com/liujinxin_ark/quick-template/tree/relase-3.0]~~ 后续版本不在使用该仓库
仓库迁移：https://gitee.com/schema-template/quick-template.git （由于码云近期维护，暂无法访问）

软件架构

SpringBoot多模块 + shiro实现权限认证 + redis实现单点登录控制（可控制账户同时在线人数）+ Swagger文档

2.0时新增了 quick-log-serve ，此次3.0增加了 quick-storage 文件存储服务，可以以SDK包的方式引入（注意3.1版本上才有quick-job模块功能,如需要请一致3.1版本下载）。
在这里插入图片描述

quick-auth-serve 工程

quick-auth-serve 为认证服务，包含系统认证、鉴权，以及系统得用户、角色、权限管理。

shiro相关信息配置可通过quick-config模块下得application-shiro.yml配置，如：令牌前缀、同一个帐号最大会话数、认证授权信息缓存等配置。

该对其他子模块提供了 ShiroUtil 类，通过该类获取当前登录用户信息。

注意：
如果需要关闭项目的认证鉴权功能，在 quick-config 工程下的 application-shiro.yml 关闭认证鉴权功能：

在这里插入图片描述

quick-log-serve 工程

quick-log-serve 为日志服务，包含系统日志访问接口。

该对其他子模块提供了 LogbackController 接口，通过该接口访问系统 html 和 txt 的Logback日志文件。
如：http://localhost:8082/log-server-api/logback/html/2022-03-24?accessKey=F9F09728BBC81DA9&level=info 可访问html日志信息记录

接口： /log-server-api/logback/{type}/{dateTime}?accessKey=F9F09728BBC81DA9&level=info
type参数：日志类型可选值html、txt
dataTime参数：某一天的日志信息
accessKey参数：令牌（该接口不会参与到 quick-auth-serve 服务的认证鉴权，所以单独开发了这个接口）
level参数：如果type参数为txt的话，该值生效。即访问的日志文件级别。

注意：
如果不要对外开发该接口，可在 application-log.yml 中禁用该接口。
加入了日志到数据库表中功能，记录请求和响应的信息，log服务只会记录需要鉴权的接口到表中，可在application-log.yml 中该功能。

quick-common 工程

quick-auth-serve 为常用的工具服务，包含提供redisClient、File操作、Word转PDF等工具类。

quick-config 工程

quick-condig 系统统一配置服务。

（1）每个子模块都有自己数据源配置，实现各个子模块连接自己的数据源，参考com.quick.config.datasource 数据源配置类和 application-db.yml 配置文件，可访问 IP:端口/druid 访问数据源监控。

（2）各个server模块，需要在 quick-config 工程中下的 application-system.yml 配置 request 前缀：

# 设置子模块请求前缀
request:
  prefix:
    auth_server: /auth-server-api
    log_server: /log-server-api
    base_server: /base-server-api

（3）系统配置了 sentinel 实现接口限流配置，项目启动后会自动注册到 sentinel 服务中，（自动注册配置类 com.quick.config.sentinel.SentinelConfig），即系统扫描所有接口，注册到 sentinel 服务（sentinel 程序在 control 目录下）。

注意：
如果需要关闭接口限流功能，可在 application-sentinel.yml 中关闭该功能。

（4）swagger配置，各个对外暴露的接口工程，都实现了swagger分组功能，配置类 com.quick.config.swagger.SwaggerConfig，项目启动后访问 IP:端口/doc.html 。
在这里插入图片描述

quick-base-serve 工程

该工程为一个案例工程，如项目中需要开发一个订单模块，可按照该模块创建。

注意：
不同的子模块需要在config-server工程中配置各自的数据源；
不同的子模块提供controller接口需要在config-server工程中配置各自的swagger配置分组
不同的子模块可自行配置 @RequestMapping 前缀，在quick-config工程中的 application-system.yml配置。

quick-web-serve 工程

该工程为启动工程，通过QuickWebApplication启动器启动项目。

control 目录

项目涉及到的其他服务，如：sentinel-dashboard-1.8.3.jar

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)