ToB企服应用市场:ToB评测及商务社交产业平台

标题: 还在写恶心的trim代码吗？用这个注解让你舒舒服服 [打印本页]

---

作者: 丝    时间: 2023-3-16 03:14
标题: 还在写恶心的trim代码吗？用这个注解让你舒舒服服
背景

业务系统开发时，你是否踩过这样的坑：

• 业务说列表筛选姓名精准查询查不到人？
  
• 导入数据时，明明看起来一样的ID却匹配不到DB里的数据？
  
• 看起来一样的内容，SQL Group By 时出现好几行？
  
• ……
  

DEBUG后发现，原来要么时用户传入或者导入的数据里有个空格，要么是数据库里不知道什么时候已经存了一个前后有空格的值。
总之，我们不知道它什么时候暴雷，开放的接口你也无法确定调用方（前端、服务间RPC调用、本应用内调用等）是否都帮你去除了两端空格，为了保证代码的健壮性，你只好写了如下般的代码：

1. @PostMapping(value = "/login")
2. public ResponseEntity<UserDetails> login(String username, String password, String captcha) {
3.     Assert.hasText(username, "用户名不能为空");
4.     Assert.hasText(password, "密码不能为空");
5.     Assert.hasText(captcha, "验证码不能为空");
7.     // 判断具有有效值后，还需要去除两端空白符
8.     username = username.trim();
9.     password = password.trim();
10.     captcha = captcha.trim();
12.     // Security Authorization...
14.     return new ResponseEntity(null, HttpStatus.OK);
15. }

复制代码

又或者，对象实体里更恶心的：

1. @Data
2. static class Student {
3.     private String name;
4.     private String phone;
5.     private String idCard;
6.     private String city;
7.     private String specializedSubject;
8. }
10. @PostMapping(value = "/save")
11. public ResponseEntity<UserDetails> save(Student student) {
12.     Assert.notNull(student, "参数不能为空");
13.     Assert.hasText(student.getName(), "学生姓名不能为空");
14.     Assert.hasText(student.getIdCard(), "学生身份证号不能为空");
16.     // 判断具有有效值后，还需要去除两端空白符
17.     student.setName(student.getName().trim());
18.     student.setIdCard(student.getIdCard().trim());
20.     // 可选值如果有长度，还需要去除两端空白符；似乎感觉绝大多数的String类型参数都要去除两端空白符
21.     if (StringUtils.hasLength(student.getCity())) {
22.         student.setCity(student.getCity().trim());
23.     }
24.     if (StringUtils.hasLength(student.getPhone())) {
25.         student.setPhone(student.getPhone().trim());
26.     }
27.     if (StringUtils.hasLength(student.getSpecializedSubject())) {
28.         student.setSpecializedSubject(student.getSpecializedSubject().trim());
29.     }
31.     // Service call...
33.     return new ResponseEntity(null, HttpStatus.OK);
34. }

复制代码

然后你发现，似乎整个业务系统里，绝大多数的字符串类型参数，都应该去除两端空白符，可是每个字段你都这么写一遍，不仅篇幅过长，还极其恶心人。
那怎么办？又想代码健壮一点，避免暴雷，又想代码简洁增强可读性。
那你可以试一下AutoTrim这个小巧的工具，它可以帮你优雅地解决这个情况。
AutoTrim

概述

**AutoTrim**是一个小巧且nice的APT工具，它能够帮你减少String类型参数的trim()代码书写。
什么APT工具？就是类似于Lombok，APT（Annotation Processing Tool），也就是大家常说的编译期间注解处理器。
注解

• @AutoTrim对注释的对象进行AutoTrim操作，即添加 string == null ? null : string.trim() 代码.
  
• @AutoTrim.Ignored进行AutoTrim操作时，忽略对该注释的对象。
  

快速使用

• 添加依赖
  

1. <dependency>
2.     <groupId>com.supalle</groupId>
3.     <artifactId>auto-trim</artifactId>
4.     <version>1.0.0</version>
5.     <scope>provided</scope>
6. </dependency>

复制代码

• 使用注解改写上面的伪代码
  
  
  • 伪代码 1 改写：
    
  
  

1. // 只需要在方法上用@AutoTrim注解修饰即可
2. @AutoTrim
3. @PostMapping(value = "/login")
4. public ResponseEntity<UserDetails> login(String username, String password, String captcha) {
5.     Assert.hasText(username, "用户名不能为空");
6.     Assert.hasText(password, "密码不能为空");
7.     Assert.hasText(captcha, "验证码不能为空");
9.     // Security Authorization
11.     return new ResponseEntity(null, HttpStatus.OK);
12. }
14. // 编译后，用IDEA查看反编译结果
15. @PostMapping(value = "/login")
16. public ResponseEntity<UserDetails> login(String username, String password, String captcha) {
17.     username = username == null ? null : username.trim(); // 已自动添加
18.     password = password == null ? null : password.trim(); // 已自动添加
19.     captcha = captcha == null ? null : captcha.trim();    // 已自动添加
20.     Assert.hasText(username, "用户名不能为空");
21.     Assert.hasText(password, "密码不能为空");
22.     Assert.hasText(captcha, "验证码不能为空");
24.     // Security Authorization...
26.     return new ResponseEntity(null, HttpStatus.OK);
27. }

复制代码

• 伪代码 2 改写：
  

1. // 直接给实体加上@AutoTrim注解
2. @Data
3. @AutoTrim
4. static class Student {
5.     private String name;
6.     private String phone;
7.     private String idCard;
8.     private String city;
9.     private String specializedSubject;
10. }
12. // 那么方法里的代码就可以简化为：
13. @PostMapping(value = "/save")
14. public ResponseEntity<UserDetails> save(Student student) {
15.     Assert.notNull(student, "参数不能为空");
16.     Assert.hasText(student.getName(), "学生姓名不能为空");
17.     Assert.hasText(student.getIdCard(), "学生身份证号不能为空");
19.     // Service call...
21.     return new ResponseEntity(null, HttpStatus.OK);
22. }
24. // 编译后，用IDEA查看反编译结果
25. static class Student {
26.     private String name;
27.     private String phone;
28.     private String idCard;
29.     private String city;
30.     private String specializedSubject;
32.     public void setName(String name) {
33.         this.name = name == null ? null : name.trim();
34.     }
36.     public void setPhone(String phone) {
37.         this.phone = phone == null ? null : phone.trim();
38.     }
40.     public void setIdCard(String idCard) {
41.         this.idCard = idCard == null ? null : idCard.trim();
42.     }
44.     public void setCity(String city) {
45.         this.city = city == null ? null : city.trim();
46.     }
48.     public void setSpecializedSubject(String specializedSubject) {
49.         this.specializedSubject = specializedSubject == null ? null : specializedSubject.trim();
50.     }
51. }

复制代码

代码一下子就干净起来了。
@AutoTrim.Ignored

如果你想忽略个别参数、字段、方法被@AutoTrim影响呢，可以使用@AutoTrim.Ignored注解对目标进行标记，比如：

• 方法内多个String类型的形参，忽略某一个不需要 trim()操作：
  

1. @AutoTrim
2. @PostMapping(value = "/login")
3. public ResponseEntity<UserDetails> login(String username, String password
4.                                          , @AutoTrim.Ignored String captcha) {
5.     Assert.hasText(username, "用户名不能为空");
6.     Assert.hasText(password, "密码不能为空");
7.     Assert.hasText(captcha, "验证码不能为空");
9.     // Security Authorization
11.     return new ResponseEntity(null, HttpStatus.OK);
12. }
14. // 编译后，用IDEA查看反编译结果
15. @PostMapping(value = "/login")
16. public ResponseEntity<UserDetails> login(String username, String password
17.                                          , String captcha) {
18.     username = username == null ? null : username.trim(); // 已自动添加
19.     password = password == null ? null : password.trim(); // 已自动添加
20.     // 编译时就不会为captcha参数添加 auto-trim 的代码
21.     Assert.hasText(username, "用户名不能为空");
22.     Assert.hasText(password, "密码不能为空");
23.     Assert.hasText(captcha, "验证码不能为空");
25.     // Security Authorization...
27.     return new ResponseEntity(null, HttpStatus.OK);
28. }

复制代码

• JavaBean里，某个String类型的属性不需要 trim()操作：
  

1. @Data
2. @AutoTrim
3. static class Student {
4.     private String name;
5.     @AutoTrim.Ignored
6.     private String phone;
7.     private String idCard;
8.     private String city;
9.     private String specializedSubject;
10. }
12. // 编译后，用IDEA查看反编译结果
13. static class Student {
14.     private String name;
15.     private String phone;
16.     private String idCard;
17.     private String city;
18.     private String specializedSubject;
20.     public void setName(String name) {
21.         this.name = name == null ? null : name.trim();
22.     }
24.     public void setPhone(String phone) {
25.         this.phone = phone;// 编译时就不会为phone属性的Setter方法添加 auto-trim 的代码
26.     }
28.     public void setIdCard(String idCard) {
29.         this.idCard = idCard == null ? null : idCard.trim();
30.     }
32.     public void setCity(String city) {
33.         this.city = city == null ? null : city.trim();
34.     }
36.     public void setSpecializedSubject(String specializedSubject) {
37.         this.specializedSubject = specializedSubject == null ? null : specializedSubject.trim();
38.     }
39. }

复制代码

怎么样，是不是非常简单咧。
特性

• 小巧，单一目标功能，简单易用;
  
• 支持_JDK8~JDK21_；
  
• 支持class类、接口、子类、匿名内部类的类级别；
  
• 支持属性上使用；
  
• 支持方法上使用；
  
• 支持方法形参上使用；
  
• 支持final修饰的形参；
  

源码仓库

开源协议：Apache License 2.0
GitHub：https://github.com/supalle/auto-trim
Gitee：https://gitee.com/Supalle/auto-trim
如果使用中有什么问题欢迎各位小伙伴提issues反馈，我会长期维护这个亲儿子项目。
更新周期

AutoTrim定位为单一功能，轻包袱的工具，因此暂时不会加太多其他与之无关的功能，如有新的APT点子，会另开项目推出，因此更新的频率不会太频繁。

• 修复已知bug后，发布小版本；
  
• JDK发布新版本后，会第一时间支持新的JDK版本，然后发布大版本。
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

---

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)

Powered by Discuz! X3.4