跳至主要內容

Spring Boot 企业规范

xlc5202023年11月24日JavaJava大约 8 分钟约 2487 字

Spring Boot 企业规范

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

1、正确的包目录风格

基于类型
图片
图片
基于功能模块
图片
图片

2、使用设计模式

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

3、使用 Spring Boot starter

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

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

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

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

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

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

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

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

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

图片
图片

5、使用 Lombok

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

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

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

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

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

检查此文件以供参考。

2024最新架构课程,对标培训机构
👉点击查看:Java成神之路-进阶架构视频!

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

图片
图片

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

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

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

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

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

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

7、使用 slf4j 日志

图片
图片

8、控制器仅用于路由

图片
图片

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

10、避免空指针异常

图片
图片

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

12、使用分页

图片
图片

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

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

13、使用缓存

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

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

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

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

15、使用自定义响应对象

图片
图片

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

图片
图片

17、使用注释

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

图片
图片

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

图片
图片

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

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

通常,我会遵循,

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

20、简单点

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

图片
图片

22、使用 SonarLint 插件