monolithic_arch_springboot

monolithic_arch_springboot

Spring Boot构建的BookStore单体架构后端实现

项目采用Spring Boot框架,实现BookStore单体架构后端。使用Java标准技术组件构建RESTful API,包含认证授权、数据持久化等功能。遵循DDD分层架构设计,提供详细文档,有助于学习现代Java后端开发实践。

单体架构SpringBootRESTful依赖注入持久化Github开源项目

Fenix的书店后端:单体架构实现

<p align="center"> <a href="https://icyfenix.cn" target="_blank"> <img width="180" src="https://yellow-cdn.veclightyear.com/2b54e442/1eb4776c-67ee-40ce-a210-ac02652b52b2.png" alt="logo"> </a> </p> <p align="center"> <a href="https://icyfenix.cn" style="display:inline-block"><img src="https://yellow-cdn.veclightyear.com/2b54e442/ac223299-9dde-4761-8c24-e39c18aa0bf3.svg"></a> <a href="https://travis-ci.com/fenixsoft/monolithic_arch_springboot" target="_blank" style="display:inline-block"><img src="https://travis-ci.com/fenixsoft/monolithic_arch_springboot.svg?branch=master" alt="Travis-CI"></a> <a href='https://coveralls.io/github/fenixsoft/monolithic_arch_springboot?branch=master'><img src='https://yellow-cdn.veclightyear.com/2b54e442/121343f8-c3a2-44b8-ab20-8de66f8d1931.svg?branch=master' target="_blank" style="display:inline-block" alt='Coverage Status' /></a> <a href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" style="display:inline-block"><img src="https://yellow-cdn.veclightyear.com/2b54e442/774e3c4d-c34e-4f0f-99ee-3f49d269dbf6.svg" alt="License"></a> <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" style="display:inline-block"><img src="https://yellow-cdn.veclightyear.com/2b54e442/10bf8c00-9a5d-44e8-a04d-3ef42c647fac.svg" alt="Document License"></a> <a href="https://icyfenix.cn/introduction/about-me.html" target="_blank" style="display:inline-block"><img src="https://yellow-cdn.veclightyear.com/2b54e442/e85fe726-7ecd-47ef-8c9a-c33862baeed7.svg" alt="About Author"></a> </p>

如果你此时并不了解什么是"The Fenix Project",建议先阅读<a href="https://icyfenix.cn/introduction/about-the-fenix-project.html">这部分内容</a>

单体架构是Fenix's Bookstore第一个版本的服务端实现,它与此后基于微服务(Spring Cloud、Kubernetes)、服务网格(Istio)、无服务(Serverless)架构风格实现的其他版本,在业务功能上的表现是完全一致的。如果你不是针对性地带着解决某个具体问题、了解某项具体工具、技术的目的而来,而是时间充裕,希望了解软件架构的全貌与发展的话,笔者推荐以此工程入手来了解现代软件架构,因为单体架构的结构是相对直观的,易于理解的架构,对后面接触的其他架构风格也起良好的铺垫作用。此外,笔者在对应的文档中详细分析了作为一个架构设计者,会考虑哪些的通用问题,希望把抽象的"架构"一词具象化出来。

运行程序

以下几种途径,可以运行程序,浏览最终的效果:

  • 通过Docker容器方式运行:
$ docker run -d -p 8080:8080 --name bookstore icyfenix/bookstore:monolithic

然后在浏览器访问:http://localhost:8080,系统预置了一个用户(用户名:icyfenix,密码:123456),也可以注册新用户来测试。

默认会使用HSQLDB的内存模式作为数据库,并在系统启动时自动初始化好了Schema,完全开箱即用。但这同时也意味着当程序运行结束时,所有的数据都将不会被保留。

如果希望使用HSQLDB的文件模式,或者其他非嵌入式的独立的数据库支持的话,也是很简单的。以常用的MySQL/MariaDB为例,程序中也已内置了MySQL的表结构初始化脚本,你可以使用环境变量"PROFILES"来激活SpringBoot中针对MySQL所提供的配置,命令如下所示:

$ docker run -d -p 8080:8080 --name bookstore icyfenix/bookstore:monolithic -e PROFILES=mysql

此时你需要通过Docker link、Docker Compose或者直接在主机的Host文件中提供一个名为"mysql_lan"的DNS映射,使程序能顺利链接到数据库,关于数据库的更多配置,可参考源码中的application-mysql.yml

  • 通过Git上的源码,以Maven运行:
# 克隆获取源码 $ git clone https://github.com/fenixsoft/monolithic_arch_springboot.git # 进入工程根目录 $ cd monolithic_arch_springboot # 编译打包 # 采用Maven Wrapper,此方式只需要机器安装有JDK 8或以上版本即可,无需包括Maven在内的其他任何依赖 # 如在Windows下应使用mvnw.cmd package代替以下命令 $ ./mvnw package # 运行程序,地址为localhost:8080 $ java -jar target/bookstore-1.0.0-Monolithic-SNAPSHOT.jar

然后在浏览器访问:http://localhost:8080,系统预置了一个用户(用户名:icyfenix,密码:123456),也可以注册新用户来测试。

  • 通过Git上的源码,在IDE环境中运行:
  • 以IntelliJ IDEA为例,Git克隆本项目后,在File -> Open菜单选择本项目所在的目录,或者pom.xml文件,以Maven方式导入工程。

  • IDEA将自动识别出这是一个SpringBoot工程,并定位启动入口为BookstoreApplication,待IDEA内置的Maven自动下载完所有的依赖包后,运行该类即可启动。

  • 如你使用其他的IDE,没有对SpringBoot的直接支持,亦可自行定位到BookstoreApplication,这是一个带有main()方法的Java类,运行即可。

  • 可通过IDEA的Maven面板中Lifecycle里面的package来对项目进行打包、发布。

  • 在IDE环境中修改配置(如数据库等)会更加简单,具体可以参考工程中application.yml和application-mysql.yml中的内容。

技术组件

Fenix's BookStore单体架构后端尽可能采用标准的技术组件进行构建,不依赖与具体的实现,包括:

  • JSR 370:Java API for RESTful Web Services 2.1(JAX-RS 2.1)<br/>RESTFul服务方面,采用的实现为Jersey 2,亦可替换为Apache CXF、RESTeasy、WebSphere、WebLogic等

  • JSR 330:Java 1.0的依赖注入<br/>依赖注入方面,采用的实现为SpringBoot 2中内置的Spring Framework 5。虽然在多数情况下尽可能使用了JSR 330的标准注解,但仍有少量地方由于Spring对@Named、@Inject等注解的支持表现与其自身提供的注解存在差异,使用了Spring的私有注解。如果替换为其他CDI实现,如HK2,需要进行较大的改动。

  • JSR 338:Java持久化2.2<br/>持久化方面,采用的实现为Spring Data JPA。可替换为Batoo JPA、EclipseLink、OpenJPA等实现,只需将使用CrudRepository所省略的代码手动补全即可,无需其他改动。

  • JSR 380:Bean验证2.0<br/> 数据验证方面,采用的实现为Hibernate Validator 6,可替换为Apache BVal等其他验证框架。

  • JSR 315:Java Servlet 3.0<br/> Web访问方面,采用的实现为SpringBoot 2中默认的Tomcat 9 Embed,可替换为Jetty、Undertow等其他Web服务器。

以下组件仍然依赖了非标准化的技术实现,包括:

  • JSR 375:Java EE安全API规范1.0<br/> 认证/授权方面,2017年才发布的JSR 375中仍未直接包含OAuth2和JWT的支持。考虑到后续实现微服务架构时的对比需求,单体架构中选择了Spring Security 5作为认证服务,Spring Security OAuth 2.3作为授权服务,Spring Security JWT作为JWT令牌支持,未采用标准的JSR 375实现,如Soteria。

  • JSR 353/367:Java API for JSON处理/绑定<br/>在JSON序列化/反序列化方面,由于Spring Security OAuth的限制(使用JSON-B作为反序列化器时的结果与Jackson等有差异),采用了Spring Security OAuth默认的Jackson,未采用标准的JSR 353/367实现,如Apache Johnzon、Eclipse Yasson等。

工程结构

Fenix's BookStore单体架构后端参考(并未完全遵循)了DDD的分层模式和设计原则,整体分为以下四层:

  1. Resource:对应DDD中的用户界面层,负责向用户显示信息或解释用户发出的命令。请注意,这里的"用户"不一定是使用用户界面的人,可以是位于另一个进程或计算机的服务。由于本工程采用了MVVM前后端分离模式,这里所指的用户实际上是前端的服务消费者,所以以RESTful中的核心概念"资源"(Resource)来命名。

  2. Application:对应DDD中的应用层,负责定义软件本身对外暴露的能力,即软件可以完成哪些任务,并负责对内协调领域对象来解决问题。根据DDD原则,应用层应尽量简单,不包含任何业务规则或知识,而只为下一层中的领域对象协调任务,分配工作,使它们互相协作,这一点在代码上表现为Application层中一般不会存在任何条件判断语句。在许多项目中,Application层都会被选为包裹事务(代码进入此层事务开始,退出此层事务提交或回滚)的载体。

  3. Domain:对应DDD中的领域层,负责实现业务逻辑,即表达业务概念,处理业务状态信息以及业务规则这些行为,此层是整个项目的重点。

  4. Infrastructure:对应DDD中的基础设施层,向其他层提供通用的技术能力,如持久化能力、远程服务通讯、工具集等。

<GitHubWrapper> <p align="center"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/0b268c07-2f4c-446d-b4d7-ba5cbfb0cc8d.png" > </p> </GitHubWrapper>

协议

  • 本文档代码部分采用Apache 2.0协议进行许可。遵循许可的前提下,你可以自由地对代码进行修改,再发布,可以将代码用作商业用途。但要求你:

    • 署名:在原有代码和衍生代码中,保留原作者署名及代码来源信息。
    • 保留许可证:在原有代码和衍生代码中,保留Apache 2.0协议文件。
  • 本作品文档部分采用知识共享署名 4.0 国际许可协议进行许可。遵循许可的前提下,你可以自由地共享,包括在任何媒介上以任何形式复制、发行本作品,亦可以自由地演绎、修改、转换或以本作品为基础进行二次创作。但要求你:

    • 署名:应在使用本文档的全部或部分内容时,注明原作者及来源信息。
    • 非商业性使用:不得用于商业出版或其他任何带有商业性质的行为。如需商业使用,请联系作者。
    • 相同方式共享的条件:在本文档基础上演绎、修改的作品,应当继续以知识共享署名 4.0国际许可协议进行许可。

编辑推荐精选

扣子-AI办公

扣子-AI办公

职场AI,就用扣子

AI办公助手,复杂任务高效处理。办公效率低?扣子空间AI助手支持播客生成、PPT制作、网页开发及报告写作,覆盖科研、商业、舆情等领域的专家Agent 7x24小时响应,生活工作无缝切换,提升50%效率!

堆友

堆友

多风格AI绘画神器

堆友平台由阿里巴巴设计团队创建,作为一款AI驱动的设计工具,专为设计师提供一站式增长服务。功能覆盖海量3D素材、AI绘画、实时渲染以及专业抠图,显著提升设计品质和效率。平台不仅提供工具,还是一个促进创意交流和个人发展的空间,界面友好,适合所有级别的设计师和创意工作者。

图像生成热门AI工具AI图像AI反应堆AI工具箱AI绘画GOAI艺术字堆友相机
码上飞

码上飞

零代码AI应用开发平台

零代码AI应用开发平台,用户只需一句话简单描述需求,AI能自动生成小程序、APP或H5网页应用,无需编写代码。

Vora

Vora

免费创建高清无水印Sora视频

Vora是一个免费创建高清无水印Sora视频的AI工具

Refly.AI

Refly.AI

最适合小白的AI自动化工作流平台

无需编码,轻松生成可复用、可变现的AI自动化工作流

酷表ChatExcel

酷表ChatExcel

大模型驱动的Excel数据处理工具

基于大模型交互的表格处理系统,允许用户通过对话方式完成数据整理和可视化分析。系统采用机器学习算法解析用户指令,自动执行排序、公式计算和数据透视等操作,支持多种文件格式导入导出。数据处理响应速度保持在0.8秒以内,支持超过100万行数据的即时分析。

AI工具使用教程AI营销产品酷表ChatExcelAI智能客服
TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

热门AI工具生产力协作转型TraeAI IDE
AIWritePaper论文写作

AIWritePaper论文写作

AI论文写作指导平台

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

数据安全AI助手热门AI工具AI辅助写作AI论文工具论文写作智能生成大纲
博思AIPPT

博思AIPPT

AI一键生成PPT,就用博思AIPPT!

博思AIPPT,新一代的AI生成PPT平台,支持智能生成PPT、AI美化PPT、文本&链接生成PPT、导入Word/PDF/Markdown文档生成PPT等,内置海量精美PPT模板,涵盖商务、教育、科技等不同风格,同时针对每个页面提供多种版式,一键自适应切换,完美适配各种办公场景。

热门AI工具AI办公办公工具智能排版AI生成PPT博思AIPPT海量精品模板AI创作
潮际好麦

潮际好麦

AI赋能电商视觉革命,一站式智能商拍平台

潮际好麦深耕服装行业,是国内AI试衣效果最好的软件。使用先进AIGC能力为电商卖家批量提供优质的、低成本的商拍图。合作品牌有Shein、Lazada、安踏、百丽等65个国内外头部品牌,以及国内10万+淘宝、天猫、京东等主流平台的品牌商家,为卖家节省将近85%的出图成本,提升约3倍出图效率,让品牌能够快速上架。

下拉加载更多