Java的Comparable接口的一個(gè)陷阱
Java的Comparable接口提供一個(gè)對(duì)實(shí)現(xiàn)了這個(gè)接口的對(duì)象列表進(jìn)行排序的辦法。原始的排序?qū)τ诤?jiǎn)單的對(duì)象來(lái)說(shuō)具有意義,但是當(dāng)我們面對(duì)復(fù)雜的面向?qū)ο蟮臉I(yè)務(wù)邏輯對(duì)象時(shí),事情變得復(fù)雜的多。從業(yè)務(wù)經(jīng)理的角度來(lái)看,一些交易對(duì)象的自然順序可能是按照交易的價(jià)值來(lái)排序的,但是從系統(tǒng)管理員的角度來(lái)看,這個(gè)排序的規(guī)則可能是交易的速度。所以在大多數(shù)情況下,并沒(méi)有明確的業(yè)務(wù)領(lǐng)域?qū)ο蟮淖匀慌判蛞?guī)則。
假設(shè)我們找到了一個(gè)需要排序的類,比如說(shuō)Campany。我們把公司的offical name作為主關(guān)鍵字,把id作為次要關(guān)鍵字。這個(gè)類的實(shí)現(xiàn)如下:
- public class Company implements Comparable<Company> {
- private final String id;
- private final String officialName;
- public Company(final String id, final String officialName) {
- this.id = id;
- this.officialName = officialName;
- }
- public String getId() {
- return id;
- }
- public String getOfficialName() {
- return officialName;
- }
- @Override
- public int hashCode() {
- HashCodeBuilder builder = new HashCodeBuilder(17, 29);
- builder.append(this.getId());
- builder.append(this.getOfficialName());
- return builder.toHashCode();
- }
- @Override
- public boolean equals(final Object obj) {
- if (obj == this) {
- return true;
- }
- if (!(obj instanceof Company)) {
- return false;
- }
- Company other = (Company) obj;
- EqualsBuilder builder = new EqualsBuilder();
- builder.append(this.getId(), other.getId());
- builder.append(this.getOfficialName(), other.getOfficialName());
- return builder.isEquals();
- }
- @Override
- public int compareTo(final Company obj) {
- CompareToBuilder builder = new CompareToBuilder();
- builder.append(this.getOfficialName(), obj.getOfficialName());
- builder.append(this.getId(), obj.getId());
- return builder.toComparison();
- }
- }
這個(gè)實(shí)現(xiàn)看起來(lái)沒(méi)問(wèn)題,假設(shè)現(xiàn)在這個(gè)類提供的信息不夠使用,我們又創(chuàng)建了這個(gè)類的一個(gè)子類CompanyDetail類用以擴(kuò)展他。例如我們想以一個(gè)表的形式顯示公司的信息,我們就可以用這個(gè)類。
- public class CompanyDetails extends Company {
- private final String marketingName;
- private final Double marketValue;
- public CompanyDetails(final String id, final String officialName, final String marketingName, final Double marketValue) {
- super(id, officialName);
- this.marketingName = marketingName;
- this.marketValue = marketValue;
- }
- public String getMarketingName() {
- return marketingName;
- }
- public Double getMarketValue() {
- return marketValue;
- }
- @Override
- public int hashCode() {
- HashCodeBuilder builder = new HashCodeBuilder(19, 31);
- builder.appendSuper(super.hashCode());
- builder.append(this.getMarketingName());
- return builder.toHashCode();
- }
- @Override
- public boolean equals(final Object obj) {
- if (obj == this) {
- return true;
- }
- if (!(obj instanceof CompanyDetails)) {
- return false;
- }
- CompanyDetails other = (CompanyDetails) obj;
- EqualsBuilder builder = new EqualsBuilder();
- builder.appendSuper(super.equals(obj));
- builder.append(this.getMarketingName(), other.getMarketingName());
- builder.append(this.getMarketValue(), other.getMarketValue());
- return builder.isEquals();
- }
- }
這個(gè)類的實(shí)現(xiàn)看起來(lái)還是沒(méi)什么問(wèn)題,但是事實(shí)上是有問(wèn)題的,我們可以寫一個(gè)test指出問(wèn)題在哪里。當(dāng)我們沒(méi)有對(duì)父類的所有細(xì)節(jié)加以注意時(shí),問(wèn)題就來(lái)了。
- CompanyDetails c1 = new CompanyDetails("231412", "McDonalds Ltd", "McDonalds food factory", 120000.00);
- CompanyDetails c2 = new CompanyDetails("231412", "McDonalds Ltd", "McDonalds restaurants", 60000.00);
- Set<CompanyDetails> set1 = CompaniesFactory.createCompanies1();
- set1.add(c1);
- set1.add(c2);
- Set<CompanyDetails> set2 = CompaniesFactory.createCompanies2();
- set2.add(c1);
- set2.add(c2);
- Assert.assertEquals(set1.size(), set2.size());
我們構(gòu)造了兩個(gè)set,但是結(jié)果是assert的結(jié)果是不相等。這是為什么?其中一個(gè)set是一個(gè)HashSet,他依賴對(duì)象的hashCode()和equals()方法,但是另一個(gè)是TreeSet,他只是依賴Comparable接口,而這個(gè)接口在子類中我們并沒(méi)有實(shí)現(xiàn)。在領(lǐng)域?qū)ο蟊粩U(kuò)展的時(shí)候這是很常見的一個(gè)錯(cuò)誤,但是更重要的是這是不好的編碼約定造成的。我們使用Apache Commons包中的builder來(lái)實(shí)現(xiàn)hashCode(),equals().和compareTo()方法。這些builder提供了appendSuper()方法,此方法指示了如何調(diào)用這些方法在父類中的實(shí)現(xiàn)。如果你看過(guò)Joshua Bloch 的Effective Java,你會(huì)發(fā)現(xiàn)這是錯(cuò)誤的。如果我們?cè)谧宇愔刑砑映蓡T變量,在不違反對(duì)稱規(guī)則的情況下,我們就不能正確的實(shí)現(xiàn)equals()方法和compareTo()方法。我們應(yīng)該使用組合的方式而不是繼承。如果我們使用組合的方式構(gòu)造CompanyDetails,對(duì)于Comparable接口來(lái)說(shuō)沒(méi)有任何問(wèn)題,因?yàn)槲覀儧](méi)有自動(dòng)的實(shí)現(xiàn),而且在默認(rèn)的情況允許不同的行為。而且我們也能滿足正確的equals()和hashCode()的需求。
這篇文章提到的問(wèn)題非常普遍,但是經(jīng)常被忽視。Comparable接口的問(wèn)題實(shí)際是由于不好的約定和對(duì)使用的接口需求的錯(cuò)誤理解造成的。作為一個(gè)Java開發(fā)人員或架構(gòu)師,你應(yīng)該特別注意這樣的事情,并遵守良好的編碼習(xí)慣和做法。 越大的項(xiàng)目,這種問(wèn)題就越顯得重要。這里我總結(jié)了一個(gè)使用Comparable接口的最佳實(shí)踐,可以避免這個(gè)錯(cuò)誤。
Java的Comparable接口的設(shè)計(jì)和使用的最佳實(shí)踐:
- 了解你需要?jiǎng)?chuàng)建的領(lǐng)域?qū)ο?,如果?duì)象沒(méi)有明確的排序規(guī)則,請(qǐng)不要實(shí)現(xiàn)Comparable接口。
- 更多的使用Comparator而不是Comparable,Comparator在更多的業(yè)務(wù)使用方式時(shí)要顯得更為實(shí)用。
- 如果你需要?jiǎng)?chuàng)建依賴Comparable接口的接口或者庫(kù),如果可能的話你提供自己的Comparator實(shí)現(xiàn),否則就寫一個(gè)良好的文檔指明在你的接口實(shí)現(xiàn)類中如何實(shí)現(xiàn)。
- 遵守良好的編碼習(xí)慣和做法。Effective Java是很好的推薦。
原文鏈接:http://my.oschina.net/jack230230/blog/56339
【編輯推薦】