新來個(gè)技術(shù)總監(jiān)：誰在用isXxx形式定義布爾類型年后不用來了

在日常開發(fā)中，我們會(huì)經(jīng)常要在類中定義布爾類型的變量，比如在給外部系統(tǒng)提供一個(gè)RPC接口的時(shí)候，我們一般會(huì)定義一個(gè)字段表示本次請求是否成功的。

關(guān)于這個(gè)”本次請求是否成功”的字段的定義，我見過很多不同的開發(fā)者，定義的方式都不同，尤其是在屬性的命名上，有人用 success，有人用 isSuccess 表示。

從語義上面來講，兩種命名方式都可以講的通，并且也都沒有歧義。那么還有什么原則可以參考來讓我們做選擇呢。

根據(jù)JavaBeans Specification規(guī)定，如果是普通的參數(shù)propertyName，要以以下方式定義其setter/getter：

publicget();

publicvoidset(a);

但是，布爾類型的變量propertyName則是單獨(dú)定義的：

publicbooleanis();

publicvoidset(booleanm);

success方法的 getter 應(yīng)該是isSuccess/getSuccess，而isSuccess的getter 應(yīng)該是isIsSuccess/getIsSuccess。

基于 Spring Boot + MyBatis Plus + Vue & Element 實(shí)現(xiàn)的后臺管理系統(tǒng) + 用戶小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

• 項(xiàng)目地址：https://github.com/YunaiV/ruoyi-vue-pro
• 視頻教程：https://doc.iocoder.cn/video/

但是很多人，在使用isSuccess作為屬性名的時(shí)候，還是會(huì)采用isSuccess/getSuccess作為 getter 方法名，尤其是現(xiàn)在的很多 IDE 在默認(rèn)生成 getter 的時(shí)候也是會(huì)生成isSuccess。

在一般情況下，其實(shí)是沒有影響的。但是有一種特殊情況就會(huì)有問題，那就是發(fā)生序列化的時(shí)候可能會(huì)導(dǎo)致參數(shù)轉(zhuǎn)換異常。

我們先來定義一個(gè) JavaBean：

classModelimplementsSerializable{


privatestaticfinallongserialVersionUID=1836697963736227954L;

privatebooleanisSuccess;

publicbooleanisSuccess(){

returnisSuccess;

}

publicvoidsetSuccess(booleansuccess){

isSuccess=success;

}

publicStringgetHollis(){

return"yudaoyuanma";

}

}

在這個(gè) JavaBean 中，有一個(gè)成員變量isSuccess，三個(gè)方法，分別是IDE幫我們自動(dòng)生成的isSuccess和setSuccess，另外一個(gè)是作者自己增加的一個(gè)符合getter命名規(guī)范的方法。

我們分別使用不同的 JSON 序列化工具來對這個(gè)類的對象進(jìn)行序列化和反序列化：

publicclassBooleanMainTest{

publicstaticvoidmain(String[]args)throwsIOException{

//定一個(gè)Model類型

Modelmodel=newModel();

model.setSuccess(true);



//使用fastjson(1.2.16)序列化model成字符串并輸出

System.out.println("SerializableResultWithfastjson:"+JSON.toJSONString(model));



//使用Gson(2.8.5)序列化model成字符串并輸出

Gsongson=newGson();

System.out.println("SerializableResultWithGson:"+gson.toJson(model));



//使用jackson(2.9.7)序列化model成字符串并輸出

ObjectMapperom=newObjectMapper();

System.out.println("SerializableResultWithjackson:"+om.writeValueAsString(model));

}

}

以上代碼輸出結(jié)果：

SerializableResultWithfastjson:{"yudao":"yudaoyuanma","success":true}

SerializableResultWithGson:{"isSuccess":true}

SerializableResultWithjackson:{"success":true,"yudao":"yudaoyuanma"}

在fastjson和jackson的結(jié)果中，原來類中的isSuccess字段被序列化成success，并且其中還包含yudao值。而Gson中只有isSuccess字段。

我們可以得出結(jié)論：fastjson和jackson在把對象序列化成json字符串的時(shí)候，是通過反射遍歷出該類中的所有g(shù)etter方法，得到getHollis和isSuccess，然后根據(jù)JavaBeans規(guī)則，他會(huì)認(rèn)為這是兩個(gè)屬性yudao和success的值。直接序列化成json:

{“yudao”:”yudaoyuanma”,”success”:true}

但是Gson并不是這么做的，他是通過反射遍歷該類中的所有屬性，并把其值序列化成json:

{“isSuccess”:true}

可以看到，由于不同的序列化工具，在進(jìn)行序列化的時(shí)候使用到的策略是不一樣的 ，所以，對于同一個(gè)類的同一個(gè)對象的序列化結(jié)果可能是不同的。那么，如果我們把一個(gè)對象使用fastjson進(jìn)行序列化，再使用Gson反序列化會(huì)發(fā)生什么呢？

publicclassBooleanMainTest{

publicstaticvoidmain(String[]args)throwsIOException{

Modelmodel=newModel();

model.setSuccess(true);

Gsongson=newGson();

System.out.println(gson.fromJson(JSON.toJSONString(model),Model.class));

}

}

以上代碼，輸出結(jié)果：

Model[isSuccess=false]

這和我們預(yù)期的結(jié)果完全相反，原因是因?yàn)镴SON框架通過掃描所有的getter后發(fā)現(xiàn)有一個(gè)isSuccess方法，然后根據(jù)JavaBeans的規(guī)范，解析出變量名為success，把model對象序列化城字符串后內(nèi)容為{"success":true}。

根據(jù){"success":true}這個(gè)json串，Gson框架在通過解析后，通過反射尋找Model類中的success屬性，但是Model類中只有isSuccess屬性，所以，最終反序列化后的Model類的對象中，isSuccess則會(huì)使用默認(rèn)值false。

但是，一旦以上代碼發(fā)生在生產(chǎn)環(huán)境，這絕對是一個(gè)致命的問題。

所以，作為開發(fā)者，我們應(yīng)該想辦法盡量避免這種問題的發(fā)生。

所以，建議大家使用success而不是 isSuccess 這種形式。 這樣，該類里面的成員變量時(shí)success，getter方法是isSuccess，這是完全符合JavaBeans規(guī)范的。無論哪種序列化框架，執(zhí)行結(jié)果都一樣。就從源頭避免了這個(gè)問題。

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實(shí)現(xiàn)的后臺管理系統(tǒng) + 用戶小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

• 項(xiàng)目地址：https://github.com/YunaiV/yudao-cloud
• 視頻教程：https://doc.iocoder.cn/video/