SpringBoot 22 条最佳实践

简单的springboot整合activiti5.22.0 springboot整合activiti5.22.0 阅读详情

👉 这是一个或许对你有用的社群

🐱 一对一交流/面试小册/简历优化/求职解惑,欢迎加入「芋道快速开发平台」知识星球。下面是星球提供的部分资料: 

d277dcf01fef5ff6e7eb2b539d97f173.gif

👉这是一个或许对你有用的开源项目

国产 Star 破 10w+ 的开源项目,前端包括管理后台 + 微信小程序,后端支持单体和微服务架构。

功能涵盖 RBAC 权限、SaaS 多租户、数据权限、商城、支付、工作流、大屏报表、微信公众号等等功能:

  • Boot 地址:https://gitee.com/zhijiantianya/ruoyi-vue-pro

  • Cloud 地址:https://gitee.com/zhijiantianya/yudao-cloud

  • 视频教程:https://doc.iocoder.cn

来源:medium.com/@raviyasas/
spring-boot-best-practices-for-
developers-3f3bdffa0090

ac48752c0a7d7a41265f1833748dbe5b.jpeg


Spring Boot 是一种广泛使用且非常流行的企业级高性能框架。以下是一些最佳实践和一些技巧,我们可以使用它们来改进 Spring Boot 应用程序并使其更加高效。这篇文章会有点长,完整读完文章需要一些时间。

1.正确的包目录风格

  • 正确的包目录将有助于轻松理解代码和应用程序的流程。

  • 我们可以使用有意义的包目录来构建我们的应用程序。

  • 我们可以将所有控制器包含在单独的包中,将服务包含在单独的包中,将 util 类包含在单独的包中等等。这种风格在小型微服务中非常方便。

  • 如果我们正在处理庞大的代码库,则可以使用基于功能模块的方法。我们可以根据我们的要求来决定。

基于类型
54cf2d83c5ad2904d7a535c478b66a11.png
基于功能模块
23bc996ca25634ae6af9ae208af740fd.png

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址:https://github.com/YunaiV/ruoyi-vue-pro

  • 视频教程:https://doc.iocoder.cn/video/

2.使用设计模式

没什么好说的,设计模式已经是现代编程中编写可维护、可扩展代码的最佳实践。

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址:https://github.com/YunaiV/yudao-cloud

  • 视频教程:https://doc.iocoder.cn/video/

3.使用 Spring Boot starter

这是 Spring Boot 的一个很酷的功能。

我们可以非常轻松地使用启动器依赖项,而无需一一添加单个依赖项。这些入门依赖项已与所需的依赖项捆绑在一起。

例如,如果我们添加 spring-boot-starter-web 依赖项,默认情况下它会与 jackson、spring-core、spring-mvc 和 spring-boot-starter-tomcat 依赖项捆绑在一起。

所以我们不需要关心单独添加依赖项。

它还可以帮助我们避免版本不匹配。

4.使用生产版本的依赖项

始终建议使用最新的稳定 GA 版本。

有时它可能会因 Java 版本、服务器版本、应用程序类型等而有所不同。

不要使用同一包的不同版本,如果存在多个依赖项,请始终使用<properties>指定版本。

69a0c59b8af4e54ffcbb4d7383ab26f2.png

5.使用 Lombok

作为一名 Java 开发人员,我们可能听说过 Lombok 项目。

Lombok 是一个 Java 库,可用于减少代码并允许我们使用其注释编写干净的代码。

例如,我们可能在某些类(如实体、请求/响应对象、dtos 等)中使用大量的 getter 和 setter 行。

但如果你使用 Lombok,它只是一行,你可以根据你的要求使用@Data、@Getter 或@Setter。

我们也可以使用 Lombok 记录器注释。推荐@Slf4j。

检查此文件以供参考。

6.将构造函数注入与 Lombok 一起使用

ce1b0e28e44c640462523946f77f2127.png

当我们谈论依赖注入时,有两种类型。

一种是“构造函数注入”,另一种是“setter 注入”。除此之外,我们还可以使用非常流行的@Autowired 注释来使用“字段注入”。

但我们强烈建议使用构造函数注入而不是其他类型。因为它允许应用程序在初始化时初始化所有必需的依赖项。

这对于单元测试非常有用。

重要的是,我们可以使用 Lombok 的 @RequiredArgsConstructor 注释来使用构造函数注入。

检查此示例控制器以供参考。

7.使用 slf4j 日志

17aaf738bca3e9de05bdf5b4c9438dc9.png
  • 日志记录非常重要。

  • 如果我们的应用程序在生产过程中出现问题,日志记录是找出根本原因的唯一方法。

  • 因此,在添加记录器、日志消息类型、记录器级别和记录器消息之前应该仔细考虑。

  • 不要使用 System.out.print()

  • 建议将 Slf4j 与 Spring Boot 中默认的日志框架 logback 一起使用。

  • 始终使用 slf4j 的 {} 占位符语法,避免在记录器消息中使用字符串插值。因为字符串插值会消耗更多的内存。

  • 我们可以使用 Lombok @Slf4j 注释非常轻松地创建日志记录器。

  • 如果我们处于微服务环境中,则可以使用 ELK 技术栈。

8.控制器仅用于路由

224ccfda94d64e2908a0467364cb3bf9.png
  • 控制器专用于路由。

  • 它是无状态且单身的。

  • DispatcherServlet 将检查控制器上的 @RequestMapping

  • 控制器是请求的最终目标,请求将交给服务层并由服务层处理。

  • 业务逻辑不应位于控制器中。

9.使用Service来实现业务逻辑

  • 完整的业务逻辑包含验证、缓存等。

  • 与持久层通信并接收结果。

  • Service也是单例的。

10.避免空指针异常

92d5783ee48457adb25e5a1834e91dd0.png
  • 为了避免 NullPointerException,我们可以使用 java.util 包中的 Optional。

  • 我们还可以使用空安全库。例如:Apache Commons StringUtils

  • 对已知对象调用 equals() 和 equalsIgnoreCase() 方法。

  • 使用 valueOf() 而不是 toString()

  • 使用基于 IDE 的 @NotNull 和 @Nullable 注释。

11.使用集合框架的最佳实践

  • 对我们的数据集使用适当的集合。

  • 将 forEach 与 Java 8 功能结合使用,并避免使用旧版 for 循环。

  • 使用接口类型而不是实现。

  • 使用 isEmpty() 而不是 size() 以获得更好的可读性。

  • 不返回空值,可以返回空集合。

  • 如果我们使用对象作为要存储在基于哈希的集合中的数据,则应重写 equals() 和 hashCode() 方法。请查看这篇文章“HashMap 内部是如何工作的”。

12.使用分页

f8081dee6f89a9f06929182cfac625f9.png

这将提高应用程序的性能。

如果我们使用 Spring Data JPA,则 PagingAndSortingRepository 使分页的使用变得非常容易且几乎不费吹灰之力。

13.使用缓存

在谈论应用程序性能时,缓存是另一个重要因素。

默认情况下,Spring Boot 通过 ConcurrentHashMap 提供缓存,我们可以通过 @EnableCaching 注解来实现这一点。如果我们对默认缓存不满意,可以使用 Redis、Hazelcast 或任何其他分布式缓存实现。

Redis 和 Hazelcast 是内存缓存方法。我们还可以使用数据库缓存实现。

14.使用自定义异常处理程序和全局异常处理

b888472f4a4d03231e8465ffe1bc1766.png
  • 这在使用大型企业级应用程序时非常重要。

  • 除了一般异常之外,我们可能还会有一些场景来识别某些特定的错误情况。

  • 异常顾问可以使用@ControllerAdvice 创建,我们可以创建具有有意义细节的单独异常。

  • 它将使得将来识别和调试错误变得更加容易。

15.使用自定义响应对象

10b5af316efa05884b447a89e05bf417.png
  • 自定义响应对象可用于返回包含某些特定数据的对象,并满足 HTTP 状态代码、API 代码、消息等要求。

  • 我们可以使用构建器设计模式来创建具有自定义属性的自定义响应对象。

16.删除不必要的代码、变量、方法和类。

196b53db582d0b760ed7705bef42e5d9.png
  • 未使用的变量声明将占用一些内存。

  • 删除未使用的方法、类等,因为它会影响应用程序的性能。

  • 尽量避免嵌套循环。我们可以使用map代替。

17.使用注释

  • 注释是一个很好的做法。

  • 不要对一切代码发表注释。相反,我们可以使用类、函数、方法、变量等有意义的单词编写描述性代码。

  • 删除注释代码、误导性注释和故事型注释。

  • 我们可以使用注释进行警告,并解释一些乍一看难以理解的内容。

18.对类、方法、函数、变量和其他属性使用有意义的词语。

0eb2ce7204ee4f0303ab1a2312bc3c8b.png
  • 这看起来很简单,但影响却是巨大的。

  • 始终使用正确的有意义且可搜索的命名约定以及正确的大小写。

  • 通常,我们在声明类、变量和常量时使用名词或短语。例如:字符串 firstName,const isValid

  • 我们可以使用带有形容词的动词和短语来表示函数和方法。例如:readFile()、sendData()

  • 避免使用缩写变量名和意图揭示的名称。例如:int i;字符串 getExUsr;

  • 如果我们有意义地使用此功能,则可以减少声明注释行。由于它具有有意义的名称,新开发人员可以通过阅读代码轻松理解。

19.使用正确的大小写进行声明

1b1b98fcd0933db46f60ab1b9dc8937c.png

有许多不同的大小写,如大写、小写、驼峰命名、帕斯卡命名、蛇命名、大蛇式命名、短横线命名等。

但我们需要确定哪个案例专用于哪个变量。

通常,我会遵循,

  • 类 — 帕斯卡命名

  • 方法和变量 — 驼峰命名

  • 常量 — 大蛇式命名

  • 数据库相关字段 — 短横线命名

这只是一个例子,它可能与我们在公司遵循的标准不同。

20.简单点

2f6abcfc3b89813a8db7bbed9bf1e0c4.png
  • 始终尝试编写简单、可读的代码。

  • 同样简单的逻辑可以用不同的方式实现,但是如果不可读或不理解就很难理解。

  • 有时复杂的逻辑会消耗更多的内存。

  • 编写代码时尝试使用 KISS、DRY 和 SOLID 原则。我将在以后的文章中解释这一点。

21.使用通用的代码格式样式

cb50bf00e5927c42571895796e85ab43.png
  • 格式样式因开发人员而异。编码风格的改变也被认为是一种改变,并且会使代码合并变得非常困难。

  • 为了避免这种情况,团队可以采用通用的编码格式。

22.使用 SonarLint 插件

cb5ef18918bcc4dc231f8d765a896978.png

这对于识别小错误和最佳实践非常有用,以避免不必要的错误和代码质量问题。

我们可以将插件安装到我们最喜欢的 IDE 中。

最后

至此本文讲解内容到此完毕感谢阅读,希望本文能对你有所帮助。


欢迎加入我的知识星球,全面提升技术能力。

👉 加入方式,“长按”或“扫描”下方二维码噢:

d59e1b663530dc936dee541d3b11a40e.png

星球的内容包括:项目实战、面试招聘、源码解析、学习路线。

088ee1171413534215c25a3429ed27ac.png

b505833f9aa993826868e98b12b49558.pngcab13f91e898e6f2f65c3f3edf3488a6.pnge6d9cbb949631247236e618caf757b8c.png4500a81b7460f0e64caf238620699016.png

文章有帮助的话,在看,转发吧。
谢谢支持哟 (*^__^*)
Spring Boot 最佳实践.pdf Spring Boot 最佳实践.pdf Spring Boot 最佳实践.pdf Spring Boot 最佳实践.pdf Spring Boot 最佳实践.pdf Spring Boot 最佳实践.pdf Spring Boot 最佳实践.pdf 立即下载

相关推荐

BFD+OSPF+FRR:构建高可用网络的核心铁三角

摘要:VRRP、OSPF、BFD和FRR协同实现网络高可用。VRRP负责网关冗余,OSPF确保路由可达,BFD提供毫秒级故障检测,FRR实现快速路径切换。故障时,BFD立即检测并通知OSPF,FRR在OSPF收敛前切换流量,VRRP完成网关切换(如需)。BFD采用异步模式动态建立,效率最高。该机制确保业务流量无缝切换,提升网络可靠性。

A516988的博客 758

SpringBoot 生产中 16 条最佳实践

Hollis的新书限时折扣中,一本深入讲解Java基础的干货笔记!Spring Boot是最流行的用于开发微服务的Java框架。在本文中,我将与你分享自2016年以来我在专业开发中使用Spring Boot所采用的最佳实践。这些内容是基于我的个人经验和一些熟知的Spring Boot专家的文章。在本文中,我将重点介绍Spring Boot特有的实践(大多数时候,也适用于S...

HollisChuang's Blog 557

HTB Attacking GraphQL Skills Assessment

通过枚举应用,利用GraphQL API,发现sql注入点,然后利用找到flag。

qq_33522010的博客 455

SpringBoot开发最佳实践

1、SpringBoot 程序,每个类应该有一个包,没有包的话会出现问题; 2、一个合理的包结构: 3、我们通常建议您将主应用程序类放在其他类之上的根包中,主类上需要有一个@SpringBootApplication注解,默认是扫描当前包及子类下的标有@Component, @Service, @Repository, @Controller等注解的bean; 4、如果main类上不使用@SpringBootApplication注解,可以使用@EnableAutoConfigurati.

weixin_45856470的博客 483

极化码理论及算法研究6-SCL、CA-SCL及matlab仿真

极化码译码算法5——SCL/CA-SCL译码算法系列目录1、引言2、串行抵消列表(SCL)译码算法2.1、路径度量PM 系列目录 (如要找其他内容,欢迎访问我的主页寻找) #前言 #极化码概述 #极化码定义 #极化码编码 #极化码译码 #5G标准中极化码的编译码概述 #5G标准中极化码的编码 #5G标准中极化码的译码 #总结 1、引言 在上一节中,介绍了经典的SC译码算法的理论原理以及其matlab仿真代码,SC译码算法具有较低的译码复杂度,但是由于每个译码的比特信息都依赖于前面所有的比特信息的译码结果,得

1万+

STM32的GPS数据提取程序设计说明——基于NMEA0183协议

一、硬软件平台 本次程序实现效果为对GPS信号穿送来的数据进行筛选,并将筛选后的信息通过上位机显示出来,所以此次设计所需硬件包括STM32F407、RS232转TTL、CH340USB转串口模块,注意该模块在使用前,对应的系统需要安装驱动,否则串口调试助手无法识别,另外还包括JLink下载器。 本次代码设计软件为KEIL5并结合F4固件包,上位机系统为WIN7,主机系统为WIN10。 二、算法总体思路设计 由于GPS通过RS232将数据传送给板子,因此使用两个串口资源(串口1和串口2),其中一个用来

小景的博客 6183

22条 SpringBoot 最佳实践

这在使用大型企业级应用程序时非常重要。除了一般异常之外,我们可能还会有一些场景来识别某些特定的错误情况。异常顾问可以使用创建,我们可以创建具有有意义细节的单独异常。它将使得将来识别和调试错误变得更加容易。自定义响应对象可用于返回包含某些特定数据的对象,并满足 HTTP 状态代码、API 代码、消息等要求。我们可以使用构建器设计模式来创建具有自定义属性的自定义响应对象。

lingqu+wx bjmsb06 1353

RK3568部署YOLOv8的7种方法对比:量化vs非量化的性能实测与优化建议

本文针对RK3568平台,深度对比了YOLOv8模型的七种部署方法,重点分析了量化与非量化策略的性能差异。通过实测数据,详细评估了不同方法在推理速度、CPU占用、内存消耗及模型精度上的表现,并提供了从模型结构调整到系统级优化的具体建议,为边缘AI部署选型提供实用参考。

weixin_29099217的博客 531

4、SpringBoot 关闭某个特定的配置类

分析 使用@EnableAutoConfiguration注解可以让SpringBoot根据当前应用项目所依赖的jar自动配置项目的相关配置,如下: 如果开发者不需要SpingBoot的某一项,该如何实现呢?可以在@SpringBootApplication注解上进行关闭特定的自动配置,比如关闭:数据源 用途 如果未来你看到springboot中自己提供starter 提供几十个上百个配置类,如果有一些看着不爽,我想自己去写,怎么办呢? 你可以覆盖它 你可以先排除它,然后自己写。 举例子 面试题:如果

qq_41978323的博客 1515

微信小程序|基于小程序+云开发制作一个菜谱小程序

今天吃什么?这是一个让强迫症左右为难的问题,跟随此文基于小程序+云开发制作一个菜谱小程序,根据现有食材一键生成菜谱,省心又省力。

商务合作 / 项目定制 / 学习交流。个人vx:lovely_wml 1万+

C#身份验证黑科技:用量子级加密与多维防御矩阵构建坚不可摧的用户管理系统!

某金融系统因身份验证漏洞导致200万用户数据泄露,量子级防御可将攻击面缩小99.99%。

墨夶的博客 353

Spring Boot 最佳实践(一)快速入门

一、关于Spring Boot 在开始了解Spring Boot之前,我们需要先了解一下Spring,因为Spring Boot的诞生和Spring是息息相关的,Spring Boot是Spring发展到一定程度的一个产物,但并不是Spring的替代品,Spring Boot是为了让程序员更好的使用Spring。说到这里可能有些人会迷糊,那到底Spring和Spring Boot有着什么样的联系呢...

weixin_34352005的博客 728

32、社交媒体大数据中的情感分析与网络欺凌检测

本文探讨了社交媒体大数据在情感分析和网络欺凌检测中的应用。情感分析有助于应对自动化带来的社会变化、促进社会包容和推动环境保护。网络欺凌作为一种严重的在线危害,其检测依赖于数据预处理、特征提取与深度学习模型(如CNN、LSTM)进行分类。文章还总结了大数据在欺诈检测、医疗、制造、交通等领域的广泛应用,并分析了数据存储、处理速度、质量和技术工具等方面的挑战,提出了相应的应对策略。未来,随着技术进步,社交媒体大数据将在更多领域发挥关键作用。

cc789的博客 93

22条 Spring Boot 最佳实践

这在使用大型企业级应用程序时非常重要。除了一般异常之外,我们可能还会有一些场景来识别某些特定的错误情况。异常顾问可以使用创建,我们可以创建具有有意义细节的单独异常。它将使得将来识别和调试错误变得更加容易。图片自定义响应对象可用于返回包含某些特定数据的对象,并满足 HTTP 状态代码、API 代码、消息等要求。我们可以使用构建器设计模式来创建具有自定义属性的自定义响应对象。

2501_92608043的博客 507

android 蓝牙通讯demo

android 下蓝牙通讯demo,实现了发现蓝牙,使能蓝牙,通过蓝牙发送消息。

Statistics and Machine Learning Toolbox

Statistics and Machine Learning Toolbox(带书签),MATLAB统计学习工具

22条 Spring Boot 最佳实践,yyds!

Spring Boot 是一种广泛使用且非常流行的企业级高性能框架。以下是一些最佳实践和一些技巧,我们可以使用它们来改进 Spring Boot 应用程序并使其更加高效。这篇文章会有点长,完整读完文章需要一些时间。1.正确的包目录风格正确的包目录将有助于轻松理解代码和应用程序的流程。我们可以使用有意义的包目录来构建我们的应用程序。我们可以将所有控制器包含在单独的包中,将服务包含在单独的包中,将 u...

架构文摘 270

锂电池充电器电路设计 里面有电路

锂电池充电器电路设计 里面有电路 3.7V升压到5V电路设计。

22条 SpringBoot 最佳实践,yyds!

本文翻译自国外论坛 medium,原文地址:https://medium.com/@raviyasas/spring-boot-best-practices-for-developers-3f3bdffa0090Spring Boot 是一种广泛使用且非常流行的企业级高性能框架。以下是一些最佳实践和一些技巧,我们可以使用它们来改进 Spring Boot 应用程序并使其更加高效。这篇文章会有点长,...

Java知音 306

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

22 条 Spring Boot 企业级最佳实践,应有尽有,建议收藏!!

这在使用大型企业级应用程序时非常重要。除了一般异常之外,我们可能还会有一些场景来识别某些特定的错误情况。异常顾问可以使用@ControllerAdvice 创建,我们可以创建具有有意义细节的单独异常。它将使得将来识别和调试错误变得更加容易。自定义响应对象可用于返回包含某些特定数据的对象,并满足 HTTP 状态代码、API 代码、消息等要求。我们可以使用构建器设计模式来创建具有自定义属性的自定义响应对象。

Reische的博客 1020

听我的,日志还是得好好打!

日志,维基百科中对其的定义是一个或多个由服务器自动创建和维护的日志文件,其中包含其所执行活动的列表。作为开发,我们都熟悉日志的重要性,良好的日志,能帮助我们快速定位到错误发生的详情和原因,并快速解决问题。摘要日志是一种标准化的日志文件,主要用于监控系统配置和进行离线日志分析。它通常包含以下关键信息:调用时间:记录了日志产生的具体时间。日志链路 id:包括traceId和rpcId,用于追踪请求的完整路径。线程名:记录了产生日志的线程名称。接口名:记录了被调用的接口名称。

m0_74433188的博客 308
上一篇: 40 个定时任务,带你理解 RocketMQ 设计精髓!
下一篇: 最近准备跳槽的兄弟可以看看。。
公众号-芋道源码
博客等级 码龄10年 1639粉丝 377原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值