set 方法是坏味道?

本文涉及的产品
视觉智能开放平台,图像资源包5000点
NLP自然语言处理_基础版,每接口每天50万次
视觉智能开放平台,分割抠图1万点
简介: 【10月更文挑战第19天】

1 满天Setter

public void approve(final long bookId) {
   
  ...
  book.setReviewStatus(ReviewStatus.APPROVED);
  ...
}

对作品进行审核:通过 bookId,找到对应的作品,接下来,将审核状态设置成审核通过。setter 往往是缺乏封装的一种做法。很多人在写代码时,写完字段就会利用 Lombok 生成 getter、setter。setter 同 getter 一样,反映的都是对细节的暴露。

这就意味着,你不仅可以读到一个对象的数据,还可以修改一个对象的数据。相比于读数据,修改是一个更危险操作。你不知道数据会在哪里被何人以什么方式修改,造成的结果是,别人的修改会让你的代码崩溃。与之相伴的还有各种并发问题。

可变的数据可怕,比可变的数据更可怕的是不可控的变化,暴露 setter 就是这种不可控的变化。把各种实现细节完全交给对这个类不了解的使用者去修改,没有人会知道他会怎么改,所以,这种修改完全不可控。

用一个函数替代 setter,也就是把它用行为封装起来:

public void approve(final long bookId) {
   
  ...
  book.approve();
  ...
}

通过在 Book 类里引入了一个 approve 函数,将审核状态封装。

class Book {
   
  public void approve() {
   
    this.reviewStatus = ReviewStatus.APPROVED;
  }
}

作为这个类的使用者,你并不需要知道这个类到底是怎么实现的。
这里的变化也变得可控。虽然审核状态这个字段还是会修改,但你所有的修改都要通过几个函数作为入口。有任何业务上的调整,都会发生在类内部,只要保证接口行为不变,就不会影响到其它代码。
有时你会说,我这 setter 只用在初始化过程,并不需要在使用的过程去调用:

Book book = new Book();
book.setBookId(bookId);
book.setTitle(title);
book.setIntroduction(introduction);

这种只在初始化中使用的代码,压根没必要以 setter 形式存在,真正需要的是一个有参数的构造函数:

Book book = new Book(bookId, title, introduction);

消除 setter ,有一种专门的重构手法,叫做移除设值函数(Remove Setting Method)。总之setter 完全没有必要存在。

Lombok 可以在编译的过程中生成相应代码,最大的优点是不碍眼。因为它的代码是在编译阶段生成的,所以,那些生成的代码在源码级别上是不存在的。下面就是一个例子:

@Getter
@Setter
class Book {
   
  private BookId bookId;
  private String title;
  private String introduction;
}

@Getter 表示为这个类的字段生成 getter
@Setter 表示生成 setter
因为@Setter的存在,其它代码还可以调用这个类的 setter,存在的问题并不会改变。
所以,一个更好的做法是禁用@Setter。lombok.config 配置禁用@Setter:

lombok.setter.flagUsage = error
lombok.data.flagUsage = error

这里除了@Setter,还禁用了@Data,这是 Lombok 中另外一个 Annotation,表示同时生成 getter 和 setter。既然我们禁用@Setter 是为了防止生成 setter,当然也要禁用@Data了。

2 可变的数据

反对 setter,一个重要原因是它暴露了数据。
暴露数据造成的问题在于数据的修改,进而导致出现难以预料的 Bug。在上面的代码中,我们把 setter 封装成一个个的函数,实际上是把不可控的修改限制在一个有限范围内。

进一步,如果数据压根不让修改,犯下各种低级错误的机会就进一步降低。没错,在这种思路下,可变数据(Mutable Data)就成了一种坏味道,这是 Martin Fowler 在新版《重构》里增加的坏味道,它反映着整个行业对于编程的新理解。

这种想法源自函数式编程,数据建立在不改变的基础上,如果需要更新,就产生一份新的数据副本,而旧有的数据保持不变。
随着函数式编程在软件开发领域中的地位不断提高,人们对于不变性的理解也越发深刻,不变性有效地解决了可变数据产生的各种问题。

所以,Martin Fowler 在《重构》第二版里新增了可变数据作为一种坏味道,这其实反映了行业的理解也是在逐渐推进的。不过,Martin
Fowler 对于可变数据给出的解决方案,基本上是限制对于数据的更新,降低其风险,这与我们前面提到的对 setter 的封装如出一辙。

解决可变数据,还有一个解决方案

3 编写不变类

函数式编程的不变性,其中的关键点就是设计不变类。String 类就是一个不变类,比如,如果我们把字符串中的一个字符替换成另一个字符,String 类给出的函数签名是这样的:

String replace(char oldChar, char newChar);

其含义是,这里的替换并不是在原有字符串上进行修改,而是产生了一个新的字符串。

那么,在实际工作中,我们怎么设计不变类呢?

  • 所有的字段只在构造函数中初始化
  • 所有的方法都是纯函数
  • 如果需要有改变,返回一个新的对象,而不是修改已有字段

回过头来看我们之前改动的“用构造函数消除 setter”的代码,其实就是朝着这个方向在迈进。如果按照这个思路改造我们前面提到的 approve 函数,同样也可以:

class Book {
   
  public void approve() {
   
    return new Book(..., ReviewStatus.APPROVED, ...);
  }
}

这里,我们创建出了一个“其它参数和原有 book 对象一模一样,只是审核状态变成了 APPROVED ”的对象。

在 JDK 的演化中,我们可以看到一个很明显的趋势,新增的类越来越多地采用了不变类设计,比如,用来表示时间的类。
原来 Date 类里面还有各种 setter,而新增的 LocalDateTime 则一旦初始化就不会再修改。要操作这个对象,则会产生一个新对象:

LocalDateTime twoDaysLater = now.plusDays(2);

就目前的开发状态而言,想要完全消除可变数据很难做到,但可尽可能编写一些不变类。
区分类的性质。最核心要识别的对象分成两种,实体和值对象。实体对象要限制数据变化,而值对象就要设计成不变类。

函数式编程的本质,是对程序中的赋值进行了约束。基于这样的理解,连赋值本身其实都会被归入到坏味道的提示,这才是真正挑战很多人编程习惯的一点。

越来越多的语言中开始引入值类型,也就是初始化之后便不再改变的值,比如,Java 的 Valhalla 项目。像 Rust,缺省都是值类型,而如果你需要一个可以赋值的变量,反而要去专门声明。

Martin Fowler 在《重构》中还提到一个与数据相关的坏味道:全局数据(Global Data)。如果你能够理解可变数据是一种坏味道,全局数据也就很容易理解了,它们处理手法基本上是类似的。

4 总结

可变数据最直白的体现就是各种 setter:

  • 破坏了封装
  • 带来不可控的修改,给代码增添许多问题

解决它的一种方式就是移除设值函数(Remove Setting Method),将变化限制在一定的范围之内。

可变数据是《重构》第二版新增的坏味道,这其实反映了软件开发行业的一种进步,它背后的思想是函数式编程所体现的不变性。解决可变数据,一种方式是限制其变化,另一种方式是编写不变类。

在实践中,完全消除可变数据是很有挑战的。所以,一个实际的做法是,区分类的性质。值对象就要设计成不变类,实体类则要限制数据变化。

函数式编程的本质是对于赋值进行了约束,我们甚至可以把赋值作为一种坏味道的提示。很多编程语言都引入了值类型,而让变量成为次优选项。

限制可变的数据。

目录
相关文章
|
2月前
|
存储 算法 Java
解析HashSet的工作原理,揭示Set如何利用哈希算法和equals()方法确保元素唯一性,并通过示例代码展示了其“无重复”特性的具体应用
在Java中,Set接口以其独特的“无重复”特性脱颖而出。本文通过解析HashSet的工作原理,揭示Set如何利用哈希算法和equals()方法确保元素唯一性,并通过示例代码展示了其“无重复”特性的具体应用。
47 3
|
18天前
|
Java Windows
IDEA不使用lombok,如何快速生成get和set方法
【11月更文挑战第10天】在 IntelliJ IDEA 中生成 `get` 和 `set` 方法有多种方式:通过菜单操作、使用快捷键或自定义模板。菜单操作包括选择“Code”菜单中的“Generate...”,快捷键为“Alt + Insert”。自定义模板可在“File”->“Settings”->“Editor”->“Code Style”->“Java”中设置。批量生成时,可多选变量一次性生成。
idea按住alt + insert 没有出现get和set方法怎样解决
idea按住alt + insert 没有出现get和set方法怎样解决
|
2月前
|
存储
ES6中的Set数据结构的常用方法和使用场景
ES6中的Set数据结构的常用方法和使用场景
|
3月前
|
JavaScript 前端开发
JavaScript 中的新 Set 方法
JavaScript 中的新 Set 方法
26 1
|
4月前
|
Python
python中set和frozenset方法和区别
python中set和frozenset方法和区别
|
5月前
|
存储 安全 Java
详解Java中集合的List接口实现的ArrayList方法 | Set接口实现的HashSet方法
详解Java中集合的List接口实现的ArrayList方法 | Set接口实现的HashSet方法
|
6月前
|
Java Spring 容器
spring如何进行依赖注入,通过set方法把Dao注入到serves
spring如何进行依赖注入,通过set方法把Dao注入到serves
|
6月前
|
测试技术 Python
Python set 的pop()方法 返回元素并不随机
Python set 的pop()方法 返回元素并不随机
|
5月前
|
NoSQL Java Redis
Redis16-RedisTemplate快速入门,max -idle,min-idle,max-wait,用set的方法,opsForValue().set的方法
Redis16-RedisTemplate快速入门,max -idle,min-idle,max-wait,用set的方法,opsForValue().set的方法