最近在整理 Unity 代码的时候遇到一个可以逼死强迫症的情况,就是 Unity 里面对字段进行序列化让字段可以在 Inspector 中编辑的同时,要求其他类对该字段只能读取不能修改。通常情况下,我们对字段进行序列化有两种方式:
- 将类的字段直接设置成 public
- 将字段设置成 private,但是使用 [SerializeField] 标记该字段需要序列化
也许是出于便利性,我看到的大部分 Unity 源码在进行字段序列化的时候都是采用第一种方式,即直接将字段设置成 public,例如我们有一个类 MyComponent,这个类有一个代表最大生命值的字段叫 maxHealth:
public class MyComponent : MonoBehaviour
{
public int maxHealth;
}
上面的代码里,maxHealth 字段会被 Unity 自动序列化,但是它违背了面向对象编程的一个很重要的原则,即【封装】。一个字段被设置成 public 之后意味着它可以被其他类随意修改,这是一个潜在的风险,当团队开发人员越来越多的时候,很可能哪天某一个新来的程序员就把这个字段通过代码给改了,而我们的初衷是只希望该字段只能在 MyComponent 类和 Inspector 中修改。为了解决封装性的问题,我采用了第二种方式,将 maxHealth 字段改成了 private,并且加上 [SerializeField] 特性,然后新增了个只允许 get 操作的 MaxHealth 属性:
public class MyComponent : MonoBehaviour
{
[SerializeField]
private int maxHealth;
public int MaxHealth { get => maxHealth; }
}
修改之后的代码就可以满足只允许 MyComponent 和 Inspector 修改数值,其他类只能读取的要求了,但是 VS 却会给出如下的警告:
Field 'MyComponent.maxHealth' is never assigned to, and will always have its default value 0.
意思就是 maxHealth 这个字段是私有的,但是却没有进行任何的赋值操作,所以它的默认值会一直是 0,而实际上我们是通过 Inspector 赋值的,这个操作 VS 检测不到。这不是要必死我这种见不得任何代码警告的强迫症患者,于是我又对代码进行了修改:
public class MyComponent : MonoBehaviour
{
[SerializeField]
private int maxHealth = default;
public int MaxHealth { get => maxHealth; }
}
这回我给 maxHealth 直接显示赋值为 default,其实也就是 0,VS 在检查的时候就不会再有警告了,但是却有另一个提示:
经过 VS 的检查,它认为 maxHealth 可以被标记成 readonly,但是如果我真的这么干的话,又会导致 Inspector 无法修改 maxHealth 的值,另外 VS 还会提示你 default 的赋值操作是不必要的,因为默认就是这个值。
到这里,我已经无可奈何了,想要完全通过代码解决上诉所有问题已经是不可能了,只能你选择接受这个相对较弱的提示。