Spring Boot特有的实践

spring boot是最流行的用于开发微服务的java框架。在本文中,我将与你分享自2016年以来我在专业开发中使用spring boot所采用的最佳实践。这些内容是基于我的个人经验和一些熟知的spring boot专家的文章。
在本文中,我将重点介绍spring boot特有的实践(大多数时候,也适用于spring项目)。以下依次列出了最佳实践,排名不分先后。
1、使用自定义bom来维护第三方依赖
这条实践是我根据实际项目中的经历总结出的。
spring boot项目本身使用和集成了大量的开源项目,它帮助我们维护了这些第三方依赖。但是也有一部分在实际项目使用中并没有包括进来,这就需要我们在项目中自己维护版本。如果在一个大型的项目中,包括了很多未开发模块,那么维护起来就非常的繁琐。
怎么办呢?事实上,spring io platform就是做的这个事情,它本身就是spring boot的子项目,同时维护了其他第三方开源库。我们可以借鉴spring io platform来编写自己的基础项目platform-bom,所有的业务模块项目应该以bom的方式引入。这样在升级第三方依赖时,就只需要升级这一个依赖的版本而已。
io.spring.platform            platform-bom            cairo-sr3            pom            import              
2、使用自动配置
spring boot的一个主要特性是使用自动配置。这是spring boot的一部分,它可以简化你的代码并使之工作。当在类路径上检测到特定的jar文件时,自动配置就会被激活。
使用它的最简单方法是依赖spring boot starters。因此,如果你想与redis进行集成,你可以首先包括:
org.springframework.boot    spring-boot-starter-data-redis  
如果你想与mongodb进行集成,需要这样:
org.springframework.boot    spring-boot-starter-data-mongodb  
借助于这些starters,这些繁琐的配置就可以很好地集成起来并协同工作,而且它们都是经过测试和验证的。这非常有助于避免可怕的jar地狱。
https://dzone.com/articles/what-is-jar-hell
通过使用以下注解属性,可以从自动配置中排除某些配置类:
@enableautoconfiguration(exclude = {classnottoautoconfigure.class})    
但只有在绝对必要时才应该这样做。
有关自动配置的官方文档可在此处找到:
https://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-auto-configuration.html。
3、使用spring initializr来开始一个新的spring boot项目
这一条最佳实践来自josh long (spring advocate,@starbuxman)。
spring initializr 提供了一个超级简单的方法来创建一个新的spring boot项目,并根据你的需要来加载可能使用到的依赖。
https://start.spring.io/
使用initializr创建应用程序可确保你获得经过测试和验证的依赖项,这些依赖项适用于spring自动配置。你甚至可能会发现一些新的集成,但你可能并没有意识到这些。
4、考虑为常见的组织问题创建自己的自动配置
这一条也来自josh long(spring advocate,@starbuxman)——这个实践是针对高级用户的。
如果你在一个严重依赖spring boot的公司或团队中工作,并且有共同的问题需要解决,那么你可以创建自己的自动配置。
这项任务涉及较多工作,因此你需要考虑何时获益是值得投入的。与多个略有不同的定制配置相比,维护单个自动配置更容易。
如果将这个提供spring boot配置以开源库的形式发布出去,那么将极大地简化数千个用户的配置工作。
5、正确设计代码目录结构
尽管允许你有很大的自由,但是有一些基本规则值得遵守来设计你的源代码结构。
避免使用默认包。确保所有内容(包括你的入口点)都位于一个名称很好的包中,这样就可以避免与装配和组件扫描相关的意外情况;
将application.java(应用的入口类)保留在顶级源代码目录中;
我建议将控制器和服务放在以功能为导向的模块中,但这是可选的。一些非常好的开发人员建议将所有控制器放在一起。不论怎样,坚持一种风格!
6、保持@controller的简洁和专注
controller应该非常简单。你可以在此处阅读有关grasp中有关控制器模式部分的说明。你希望控制器作为协调和委派的角色,而不是执行实际的业务逻辑。以下是主要做法:
https://en.wikipedia.org/wiki/grasp(object-orienteddesign)#controller
1、控制器应该是无状态的!默认情况下,控制器是单例,并且任何状态都可能导致大量问题;2、控制器不应该执行业务逻辑,而是依赖委托;3、控制器应该处理应用程序的http层,这不应该传递给服务;4、控制器应该围绕用例/业务能力来设计。
要深入这个内容,需要进一步地了解设计rest api的最佳实践。无论你是否想要使用spring boot,都是值得学习的。
7、围绕业务功能构建@service
service是spring boot的另一个核心概念。我发现最好围绕业务功能/领域/用例(无论你怎么称呼都行)来构建服务。
在应用中设计名称类似 accountservice, userservice, paymentservice这样的服务,比起像 databaseservice、 validationservice、 calculationservice这样的会更合适一些。
你可以决定使用controler和service之间的一对一映射,那将是理想的情况。但这并不意味着,service之间不能互相调用!
8、使数据库独立于核心业务逻辑之外
我之前还不确定如何在spring boot中最好地处理数据库交互。在阅读了罗伯特·c·马丁的“clear architecture”之后,对我来说就清晰多了。
你希望你的数据库逻辑于服务分离出来。理想情况下,你不希望服务知道它正在与哪个数据库通信,这需要一些抽象来封装对象的持久性。
罗伯特c.马丁强烈地说明,你的数据库是一个“细节”,这意味着不将你的应用程序与特定数据库耦合。过去很少有人会切换数据库,我注意到,使用spring boot和现代微服务开发会让事情变得更快。
9、保持业务逻辑不受spring boot代码的影响
考虑到“clear architecture”的教训,你还应该保护你的业务逻辑。将各种spring boot代码混合在一起是非常诱人的……不要这样做。如果你能抵制诱惑,你将保持你的业务逻辑可重用。
部分服务通常成为库。如果不从代码中删除大量spring注解,则更容易创建。
10、推荐使用构造函数注入
这一条实践来自phil webb(spring boot的项目负责人, @phillip_webb)。
保持业务逻辑免受spring boot代码侵入的一种方法是使用构造函数注入。不仅是因为 @autowired注解在构造函数上是可选的,而且还可以在没有spring的情况下轻松实例化bean。
11、熟悉并发模型
我写过的最受欢迎的文章之一是“介绍spring boot中的并发”。我认为这样做的原因是这个领域经常被误解和忽视。如果使用不当,就会出现问题。
https://www.e4developer.com/2018/03/30/introduction-to-concurrency-in-spring-boot/
在spring boot中,controller和service是默认是单例。如果你不小心,这会引入可能的并发问题。你通常也在处理有限的线程池。请熟悉这些概念。
如果你正在使用新的webflux风格的spring boot应用程序,我已经解释了它在“spring’s webflux/reactor parallelism and backpressure”中是如何工作的。
12、加强配置管理的外部化
这一点超出了spring boot,虽然这是人们开始创建多个类似服务时常见的问题……
你可以手动处理spring应用程序的配置。如果你正在处理多个spring boot应用程序,则需要使配置管理能力更加强大。
我推荐两种主要方法:
1、使用配置服务器,例如spring cloud config;2、将所有配置存储在环境变量中(可以基于git仓库进行配置)。
这些选项中的任何一个(第二个选项多一些)都要求你在devops更少工作量,但这在微服务领域是很常见的。
13、提供全局异常处理
你真的需要一种处理异常的一致方法。spring boot提供了两种主要方法:
1、你应该使用handlerexceptionresolver定义全局异常处理策略;2、你也可以在控制器上添加@exceptionhandler注解,这在某些特定场景下使用可能会很有用。
这与spring中的几乎相同,并且baeldung有一篇关于rest与spring的错误处理的详细文章,非常值得一读。
https://www.baeldung.com/exception-handling-for-rest-with-spring
14、使用日志框架
你可能已经意识到这一点,但你应该使用logger进行日志记录,而不是使用system.out.println()手动执行。这很容易在spring boot中完成,几乎没有配置。只需获取该类的记录器实例:
logger logger = loggerfactory.getlogger(myclass.class);   
这很重要,因为它可以让你根据需要设置不同的日志记录级别。
15、测试你的代码
这不是spring boot特有的,但它需要提醒——测试你的代码!如果你没有编写测试,那么你将从一开始就编写遗留代码。
如果有其他人使用你的代码库,那边改变任何东西将会变得危险。当你有多个服务相互依赖时,这甚至可能更具风险。
由于存在spring boot最佳实践,因此你应该考虑将spring cloud contract用于你的消费者驱动契约,它将使你与其他服务的集成更容易使用。
16、使用测试切片让测试更容易,并且更专注
使用spring boot测试代码可能很棘手——你需要初始化数据层,连接大量服务,模拟事物……实际上并不是那么难!答案是使用测试切片。
使用测试切片,你可以根据需要仅连接部分应用程序。这可以为你节省大量时间,并确保你的测试不会与未使用的内容相关联。来自spring.io的一篇名为custom test slice with spring test 1.4的博客文章解释了这种技术。
总结
感谢spring boot,编写基于spring的微服务正变得前所未有的简单。我希望通过这些最佳实践,你的实施过程不仅会变得很快,而且从长远来看也会更加强大和成功。祝你好运!


MathWorks的产品能够更好地助力于各行业的数字化转型
自动驾驶领军企业Mobileye:我们将坚不可摧
音圈电机加持的无人机让海鲜运送的效率大大提升
新能源汽车充电时,需注意这四种充电方式,伤电池还伤车
2024年RISC-V趋势预测,AI与高性能芯片井喷
Spring Boot特有的实践
苹果三星专利战延烧中国:本土化VS旗舰店
FMC210-1路1Gsps AD、1路2.5Gsps DA的FMC子卡
时间让你掌控,时刻让你感动
土壤肥料养分测试仪的操作方法
粉尘检测仪和尘埃粒子计数器的区别是什么
电源适配器和电源模块有什么区别?
探讨机器学习在物联网中的挑战和机遇
渣浆泵冲刷磨损原因及修复方法
维密天使学编程:这是属于未来的语言
卫星通信的常用频段的详细对比
良心国产SSD诞生!坚持只用原厂原封颗粒
JPA基础概念
为什么MOSFET栅极前要放一个100Ω电阻?
工信部下一步工作的开展将在农村地区逐步部署5G网络