梦飞环报

还在写恶心的trim代码吗？用这个注解让你舒舒服服

2023-03-16 02:58 由 Supalle 发表于 #后端开发

背景

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

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

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

@PostMapping(value = "/login")
public ResponseEntity<UserDetails> login(String username, String password, String captcha) {
    Assert.hasText(username, "用户名不能为空");
    Assert.hasText(password, "密码不能为空");
    Assert.hasText(captcha, "验证码不能为空");

    // 判断具有有效值后，还需要去除两端空白符
    username = username.trim();
    password = password.trim();
    captcha = captcha.trim();

    // Security Authorization...

    return new ResponseEntity(null, HttpStatus.OK);
}

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

@Data
static class Student {
    private String name;
    private String phone;
    private String idCard;
    private String city;
    private String specializedSubject;
}

@PostMapping(value = "/save")
public ResponseEntity<UserDetails> save(Student student) {
    Assert.notNull(student, "参数不能为空");
    Assert.hasText(student.getName(), "学生姓名不能为空");
    Assert.hasText(student.getIdCard(), "学生身份证号不能为空");

    // 判断具有有效值后，还需要去除两端空白符
    student.setName(student.getName().trim());
    student.setIdCard(student.getIdCard().trim());

    // 可选值如果有长度，还需要去除两端空白符；似乎感觉绝大多数的String类型参数都要去除两端空白符
    if (StringUtils.hasLength(student.getCity())) {
        student.setCity(student.getCity().trim());
    }
    if (StringUtils.hasLength(student.getPhone())) {
        student.setPhone(student.getPhone().trim());
    }
    if (StringUtils.hasLength(student.getSpecializedSubject())) {
        student.setSpecializedSubject(student.getSpecializedSubject().trim());
    }

    // Service call...

    return new ResponseEntity(null, HttpStatus.OK);
}

然后你发现，似乎整个业务系统里，绝大多数的字符串类型参数，都应该去除两端空白符，可是每个字段你都这么写一遍，不仅篇幅过长，还极其恶心人。
那怎么办？又想代码健壮一点，避免暴雷，又想代码简洁增强可读性。
那你可以试一下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>
    <groupId>com.supalle</groupId>
    <artifactId>auto-trim</artifactId>
    <version>1.0.0</version>
    <scope>provided</scope>
</dependency>
  1. 使用注解改写上面的伪代码
    1. 伪代码 1 改写：
// 只需要在方法上用@AutoTrim注解修饰即可
@AutoTrim
@PostMapping(value = "/login")
public ResponseEntity<UserDetails> login(String username, String password, String captcha) {
    Assert.hasText(username, "用户名不能为空");
    Assert.hasText(password, "密码不能为空");
    Assert.hasText(captcha, "验证码不能为空");

    // Security Authorization

    return new ResponseEntity(null, HttpStatus.OK);
}

// 编译后，用IDEA查看反编译结果
@PostMapping(value = "/login")
public ResponseEntity<UserDetails> login(String username, String password, String captcha) {
    username = username == null ? null : username.trim(); // 已自动添加
    password = password == null ? null : password.trim(); // 已自动添加
    captcha = captcha == null ? null : captcha.trim();    // 已自动添加
    Assert.hasText(username, "用户名不能为空");
    Assert.hasText(password, "密码不能为空");
    Assert.hasText(captcha, "验证码不能为空");

    // Security Authorization...

    return new ResponseEntity(null, HttpStatus.OK);
}
  1. 伪代码 2 改写：
// 直接给实体加上@AutoTrim注解
@Data
@AutoTrim
static class Student {
    private String name;
    private String phone;
    private String idCard;
    private String city;
    private String specializedSubject;
}

// 那么方法里的代码就可以简化为：
@PostMapping(value = "/save")
public ResponseEntity<UserDetails> save(Student student) {
    Assert.notNull(student, "参数不能为空");
    Assert.hasText(student.getName(), "学生姓名不能为空");
    Assert.hasText(student.getIdCard(), "学生身份证号不能为空");

    // Service call...

    return new ResponseEntity(null, HttpStatus.OK);
}

// 编译后，用IDEA查看反编译结果
static class Student {
    private String name;
    private String phone;
    private String idCard;
    private String city;
    private String specializedSubject;

    public void setName(String name) {
        this.name = name == null ? null : name.trim();
    }

    public void setPhone(String phone) {
        this.phone = phone == null ? null : phone.trim();
    }

    public void setIdCard(String idCard) {
        this.idCard = idCard == null ? null : idCard.trim();
    }

    public void setCity(String city) {
        this.city = city == null ? null : city.trim();
    }

    public void setSpecializedSubject(String specializedSubject) {
        this.specializedSubject = specializedSubject == null ? null : specializedSubject.trim();
    }
}

代码一下子就干净起来了。

@AutoTrim.Ignored

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

  • 方法内多个String类型的形参，忽略某一个不需要 trim()操作：
@AutoTrim
@PostMapping(value = "/login")
public ResponseEntity<UserDetails> login(String username, String password
                                         , @AutoTrim.Ignored String captcha) {
    Assert.hasText(username, "用户名不能为空");
    Assert.hasText(password, "密码不能为空");
    Assert.hasText(captcha, "验证码不能为空");

    // Security Authorization

    return new ResponseEntity(null, HttpStatus.OK);
}

// 编译后，用IDEA查看反编译结果
@PostMapping(value = "/login")
public ResponseEntity<UserDetails> login(String username, String password
                                         , String captcha) {
    username = username == null ? null : username.trim(); // 已自动添加
    password = password == null ? null : password.trim(); // 已自动添加
    // 编译时就不会为captcha参数添加 auto-trim 的代码
    Assert.hasText(username, "用户名不能为空");
    Assert.hasText(password, "密码不能为空");
    Assert.hasText(captcha, "验证码不能为空");

    // Security Authorization...

    return new ResponseEntity(null, HttpStatus.OK);
}
  • JavaBean里，某个String类型的属性不需要 trim()操作：
@Data
@AutoTrim
static class Student {
    private String name;
    @AutoTrim.Ignored
    private String phone;
    private String idCard;
    private String city;
    private String specializedSubject;
}

// 编译后，用IDEA查看反编译结果
static class Student {
    private String name;
    private String phone;
    private String idCard;
    private String city;
    private String specializedSubject;

    public void setName(String name) {
        this.name = name == null ? null : name.trim();
    }

    public void setPhone(String phone) {
        this.phone = phone;// 编译时就不会为phone属性的Setter方法添加 auto-trim 的代码
    }

    public void setIdCard(String idCard) {
        this.idCard = idCard == null ? null : idCard.trim();
    }

    public void setCity(String city) {
        this.city = city == null ? null : city.trim();
    }

    public void setSpecializedSubject(String specializedSubject) {
        this.specializedSubject = specializedSubject == null ? null : specializedSubject.trim();
    }
}

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

特性

  • 小巧，单一目标功能，简单易用;
  • 支持_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点子，会另开项目推出，因此更新的频率不会太频繁。

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

热门相关：斗神战帝   大神你人设崩了   天启预报   天启预报   刺客之王