Spring Data JPA之Service编码规范

Myth丶恋晨 2022-01-26 00:17 465阅读 0赞

**乾道核心等系统后台开发Service编码规范**

# 1、编码说明 #

1）架设计之初，优先考虑降低开发成本；于是，去掉了实体类接口dao的实现类；所以，sql语句的拼写调整至service层。

2）service层中的方法，凡是调用dao层带有@Modifying注解的方法，必须加@Transactional,且增加属性rollbackFor=Exception.class

即 @Transactional(rollbackFor = Throwable.class)

凡是要求一致性的业务操作集合，需要事务管理的，也需要增加以上注解。

3）删除不需要的引用，避免引用的类被优化掉报错。idea快捷键：Ctrl+Alt+O

4）整理代码格式，idea快捷键：Ctrl+Alt+L；自写代码部分整理，避免整个体优化，代码合并冲突。

# 2、日志打印 #

1）http请求和响应参数打印，系统有统一的过滤器，在执行调用结束返给前端前系统打印请求参数和响应参数以及耗时信息；当发生异常，系统全局异常处理机制，捕获和打印异常信息，以及打印请求入参

2）必要信息打印，比如调用方法返回结果打印；

业务用关键点,要有明确的文字说明，\*\*业务，\*\*操作，\*\*执行结果等必要信息

3）执行至关键步骤打印，比如短息、邮件、推送消息、推送消息至rocketMq等；

方便问题排查

4)  可能发生异常的地方，打印日志；

5）分多步执行，每一步加日志打印；特别首次上线！

6）不同情况下，程序走不同逻辑分支点，打印日志；if else if .. else;switch case;

7）查询sql及参数打印；

目的：方便后期排查问题。

# 3、方法编写 #

1）方法体小而精：按照业务模块，进行划分；按照不同操作，再次细化；每个方法尽量控制在100行以内。

2）必要情况开启事务管理：考虑“原子性，一致性，隔离性，持久性“”，所有操作置于同一方法中，并使用@Transactional开启事务管理；

3）简化程序实现逻辑；

4）程序没必要往下执行做return；

避免if else if else 嵌套太多，或者避免使用else，让改代码看起来逻辑上很简单

5）业务实现代码写在service层，controller层仅作必要的参数校验，结果转换实体->vo；多次调用的情况下载ctr层提取一个单独的转vo的私有方法。

目的：每个方法都是一个小的执行单元，实现单一功能。

4、封装后的service层代码

BaseService<T>

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYWhhbzExODY_size_16_color_FFFFFF_t_70][]

2、BaseServiceImpl<T>，BaseService<T>的实现类

此处忽略

问题考虑：能否去掉BaseServiceImpl<T>，BaseService<T>两个泛型类

### 4、方法规范 ###

**1）**查询返回单个实体或实体List，需要转化为对应的VO，转化操作置于controller层

原因：

① 此方法可以供其他调用，不会限定死返回值；

② VO转化不涉及业务，规范上转至controller层更合理；

说明： ctr层多次调用，返回相同vo类，可以抽象出单独的转换方法。

**2）**多个查询组装成单独的VO返回，也需整体置于service层的独立方法中

原因：spring-boot默认开启只读事务，如此可以确保单次请求返回结果数据的一致性。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYWhhbzExODY_size_16_color_FFFFFF_t_70]: /images/20220126/3f165f4a5028470f8dc3c1ddfc7dff4c.png

发表评论取消回复

表情：

评论列表（有 0 条评论，465人围观）

还没有评论，来说两句吧...

相关阅读

相关【Spring Data JPA 系列】05、Spring Data JPA

![format_png][] 5、Spring data Jpa 5.1、什么是spring data jpa？官网：[docs.spring.io/spri

迈不过友情╰/ 2023年10月04日 20:48/ 0 赞/ 111 阅读

相关【Spring Data JPA 系列】05、Spring Data JPA

![format_png][] 5、Spring data Jpa 5.1、什么是spring data jpa？官网：[docs.spring.io/spri

Bertha 。/ 2023年09月24日 17:03/ 0 赞/ 91 阅读

相关 Spring Data JPA方法定义规范

Spring Data Jpa方法定义的规则： findBy+属性+（关键字）（1）简单条件查询简单条件查询：查询某一个实体类或者集合。按照Spring Data的

迈不过友情╰/ 2022年12月15日 02:55/ 0 赞/ 187 阅读

相关 spring-data-jpa

spring-data-jpa 使用方法什么是spring-data 为了简化程序与数据库交互的代码，spring提供了一个现成的dao层框架，sprin

傷城~/ 2022年08月01日 11:23/ 0 赞/ 285 阅读

相关剖析Spring之Spring Data JPA

前言目前比较成熟的 JPA 框架主要包括 Jboss 的 Hibernate EntityManager、Oracle 捐献给 Eclipse 社区的 EclipseLin

我不是女神ヾ/ 2022年07月24日 04:03/ 0 赞/ 216 阅读

相关 Spring Data JPA 4.方法定义规范

方法定义规范简单条件查询简单条件查询: 查询某一个实体类或者集合按照 Spring Data 的规范，查询方法以 find | read | ge

忘是亡心i/ 2022年05月21日 09:58/ 0 赞/ 210 阅读

相关 JPA之Spring Data JPA

JPA是Java Persistence API的简称，也称为Java持久层API，已成为目前比较流行的一种ORM技术之一，是JDK 5.0注解或XML描述对象－关系表的映射关

- 日理万妓/ 2022年05月09日 03:42/ 0 赞/ 366 阅读

相关 Spring Data JPA Specification（规范）实现复杂查询

目录持久化 API 接口概述 JpaSpecificationExecutor 常用 API JPA Specification 编码示例 -------------

╰半橙微兮°/ 2022年02月13日 14:54/ 0 赞/ 393 阅读

相关 Spring Data JPA之Service编码规范

乾道核心等系统后台开发Service编码规范 1、编码说明 1）架设计之初，优先考虑降低开发成本；于是，去掉了实体类接口dao的实现类；所以，sql语句的拼写调整至se

Myth丶恋晨/ 2022年01月26日 00:17/ 0 赞/ 466 阅读

相关 Spring Data JPA使用规范

1、不同个常场景使用方式 1）极简场景在dao中，使用方法命名； Employee getByEmployeeCodeAndDeleteStatus(Str

Myth丶恋晨/ 2022年01月25日 22:31/ 0 赞/ 260 阅读