分享令人目瞪口呆的 Java 代碼技巧

技術點

本文不是一個吹噓的文章,不會講很多高深的架構,相反,會講解很多基礎的問題和寫法問題,如果讀者自認為基礎問題和寫法問題都是不是問題,那請忽略這篇文章,節省出時間去做一些有意義的事情。

基於 Spring Boot + MyBatis Plus + Vue & Element 實現的後臺管理系統 + 用戶小程序,支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能。

項目地址:https://github.com/YunaiV/ruoyi-vue-pro

開發工具

不知道有多少”老”程序員還在使用 Eclipse,這些程序員們要不就是因循守舊,要不就是根本就不知道其他好的開發工具的存在,Eclipse 吃內存卡頓的現象以及各種偶然莫名異常的出現,都告知我們是時候尋找新的開發工具瞭。

更換 IDE

根本就不想多解釋要換什麼樣的 IDE,如果你想成為一個優秀的 Java 程序員,請更換 IntelliJ IDEA。使用 IDEA 的好處,請搜索谷歌。

別告訴我快捷鍵不好用

更換 IDE 不在我本文的重點內容中,所以不想用太多的篇幅去寫為什麼更換IDE。在這裡,我隻能告訴你,更換 IDE 隻為瞭更好、更快的寫好 Java 代碼。原因略。

別告訴我快捷鍵不好用,請嘗試新事物。

基於微服務的思想,構建在 B2C 電商場景下的項目實戰。核心技術棧,是 Spring Boot + Dubbo 。未來,會重構成 Spring Cloud Alibaba 。

項目地址:https://github.com/YunaiV/onemall

Bean

bean 使我們使用最多的模型之一,我將以大篇幅去講解 bean,希望讀者好好體會。

domain 包名

根據很多 Java 程序員的”經驗”來看,一個數據庫表則對應著一個 domain 對象,所以很多程序員在寫代碼時,包名則使用:com.xxx.domain ,這樣寫好像已經成為瞭行業的一種約束,數據庫映射對象就應該是 domain。但是你錯瞭,domain 是一個領域對象,往往我們再做傳統 Java 軟件 Web 開發中,這些 domain 都是貧血模型,是沒有行為的,或是沒有足夠的領域模型的行為的,所以,以這個理論來講,這些 domain 都應該是一個普通的 entity 對象,並非領域對象,所以請把包名改為:com.xxx.entity。

如果你還不理解我說的話,請看一下 Vaughn Vernon 出的一本叫做《IMPLEMENTING DOMAIN-DRIVEN DESIGN》(實現領域驅動設計)這本書,書中講解瞭貧血模型與領域模型的區別,相信你會受益匪淺。

DTO

數據傳輸我們應該使用 DTO 對象作為傳輸對象,這是我們所約定的,因為很長時間我一直都在做移動端 API 設計的工作,有很多人告訴我,他們認為隻有給手機端傳輸數據的時候(input or output),這些對象成為 DTO 對象。請註意!這種理解是錯誤的,隻要是用於網絡傳輸的對象,我們都認為他們可以當做是 DTO 對象,比如電商平臺中,用戶進行下單,下單後的數據,訂單會發到 OMS 或者 ERP 系統,這些對接的返回值以及入參也叫 DTO 對象。

我們約定某對象如果是 DTO 對象,就將名稱改為 XXDTO,比如訂單下發OMS:OMSOrderInputDTO。

DTO 轉化

正如我們所知,DTO 為系統與外界交互的模型對象,那麼肯定會有一個步驟是將 DTO 對象轉化為 BO 對象或者是普通的 entity 對象,讓 service 層去處理。

場景

比如添加會員操作,由於用於演示,我隻考慮用戶的一些簡單數據,當後臺管理員點擊添加用戶時,隻需要傳過來用戶的姓名和年齡就可以瞭,後端接受到數據後,將添加創建時間和更新時間和默認密碼三個字段,然後保存數據庫。

@RequestMapping("/v1/api/user")
@RestController
public class UserApi {
    @Autowired
    private UserService userService;
    @PostMapping
    public User addUser(UserInputDTO userInputDTO){
        User user = new User();
        user.setUsername(userInputDTO.getUsername());
        user.setAge(userInputDTO.getAge());
        return userService.addUser(user);
    }
}

我們隻關註一下上述代碼中的轉化代碼,其他內容請忽略:

User user = new User();
user.setUsername(userInputDTO.getUsername());
user.setAge(userInputDTO.getAge());

請使用工具

上邊的代碼,從邏輯上講,是沒有問題的,隻是這種寫法讓我很厭煩,例子中隻有兩個字段,如果有 20 個字段,我們要如何做呢?一個一個進行 set 數據嗎?當然,如果你這麼做瞭,肯定不會有什麼問題,但是,這肯定不是一個最優的做法。

網上有很多工具,支持淺拷貝或深拷貝的 Utils。舉個例子,我們可以使用 org.springframework.beans.BeanUtils#copyProperties 對代碼進行重構和優化:

@PostMapping
public User addUser(UserInputDTO userInputDTO){
    User user = new User();
    BeanUtils.copyProperties(userInputDTO,user);
    return userService.addUser(user);
}

BeanUtils.copyProperties 是一個淺拷貝方法,復制屬性時,我們隻需要把 DTO 對象和要轉化的對象兩個的屬性值設置為一樣的名稱,並且保證一樣的類型就可以瞭。如果你在做 DTO 轉化的時候一直使用 set 進行屬性賦值,那麼請嘗試這種方式簡化代碼,讓代碼更加清晰!

轉化的語義

上邊的轉化過程,讀者看後肯定覺得優雅很多,但是我們再寫 Java 代碼時,更多的需要考慮語義的操作,再看上邊的代碼:

User user = new User();
BeanUtils.copyProperties(userInputDTO,user);

雖然這段代碼很好的簡化和優化瞭代碼,但是他的語義是有問題的,我們需要提現一個轉化過程才好,所以代碼改成如下:

@PostMapping
 public User addUser(UserInputDTO userInputDTO){
         User user = convertFor(userInputDTO);
         return userService.addUser(user);
 }
 private User convertFor(UserInputDTO userInputDTO){
         User user = new User();
         BeanUtils.copyProperties(userInputDTO,user);
         return user;
 }

這是一個更好的語義寫法,雖然他麻煩瞭些,但是可讀性大大增加瞭,在寫代碼時,我們應該盡量把語義層次差不多的放到一個方法中,比如:

User user = convertFor(userInputDTO);
return userService.addUser(user);

這兩段代碼都沒有暴露實現,都是在講如何在同一個方法中,做一組相同層次的語義操作,而不是暴露具體的實現。

如上所述,是一種重構方式,讀者可以參考 Martin Fowler 的《Refactoring Imporving the Design of Existing Code》(重構 改善既有代碼的設計) 這本書中的 Extract Method 重構方式。

抽象接口定義

當實際工作中,完成瞭幾個 API 的 DTO 轉化時,我們會發現,這樣的操作有很多很多,那麼應該定義好一個接口,讓所有這樣的操作都有規則的進行。

如果接口被定義以後,那麼 convertFor 這個方法的語義將產生變化,它將是一個實現類。

看一下抽象後的接口:

public interface DTOConvert<S,T> {
    T convert(S s);
}

雖然這個接口很簡單,但是這裡告訴我們一個事情,要去使用泛型,如果你是一個優秀的 Java 程序員,請為你想做的抽象接口,做好泛型吧。

我們再來看接口實現:

public class UserInputDTOConvert implements DTOConvert {
@Override
public User convert(UserInputDTO userInputDTO) {
User user = new User();
BeanUtils.copyProperties(userInputDTO,user);
return user;
}
}

我們這樣重構後,我們發現現在的代碼是如此的簡潔,並且那麼的規范:

@RequestMapping("/v1/api/user")
@RestController
public class UserApi {
    @Autowired
    private UserService userService;
    @PostMapping
    public User addUser(UserInputDTO userInputDTO){
        User user = new UserInputDTOConvert().convert(userInputDTO);
        return userService.addUser(user);
    }
}

review code

如果你是一個優秀的 Java 程序員,我相信你應該和我一樣,已經數次重復 review 過自己的代碼很多次瞭。

我們再看這個保存用戶的例子,你將發現,API 中返回值是有些問題的,問題就在於不應該直接返回 User 實體,因為如果這樣的話,就暴露瞭太多實體相關的信息,這樣的返回值是不安全的,所以我們更應該返回一個 DTO 對象,我們可稱它為 UserOutputDTO:

@PostMapping
public UserOutputDTO addUser(UserInputDTO userInputDTO){
        User user = new UserInputDTOConvert().convert(userInputDTO);
        User saveUserResult = userService.addUser(user);
        UserOutputDTO result = new UserOutDTOConvert().convertToUser(saveUserResult);
        return result;
}

這樣你的 API 才更健全。

不知道在看完這段代碼之後,讀者有是否發現還有其他問題的存在,作為一個優秀的 Java 程序員,請看一下這段我們剛剛抽象完的代碼:

User user = new UserInputDTOConvert().convert(userInputDTO);

你會發現,new 這樣一個 DTO 轉化對象是沒有必要的,而且每一個轉化對象都是由在遇到 DTO 轉化的時候才會出現,那我們應該考慮一下,是否可以將這個類和 DTO 進行聚合呢,看一下我的聚合結果:

public class UserInputDTO {
private String username;
private int age;
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public User convertToUser(){
        UserInputDTOConvert userInputDTOConvert = new UserInputDTOConvert();
        User convert = userInputDTOConvert.convert(this);
        return convert;
    }
    private static class UserInputDTOConvert implements DTOConvert<UserInputDTO,User> {
        @Override
        public User convert(UserInputDTO userInputDTO) {
            User user = new User();
            BeanUtils.copyProperties(userInputDTO,user);
            return user;
        }
    }
}

然後 API 中的轉化則由:

User user = new UserInputDTOConvert().convert(userInputDTO);
User saveUserResult = userService.addUser(user);

變成瞭:

User user = userInputDTO.convertToUser();
User saveUserResult = userService.addUser(user);

我們再 DTO 對象中添加瞭轉化的行為,我相信這樣的操作可以讓代碼的可讀性變得更強,並且是符合語義的。

再查工具類

再來看 DTO 內部轉化的代碼,它實現瞭我們自己定義的 DTOConvert 接口,但是這樣真的就沒有問題,不需要再思考瞭嗎?

我覺得並不是,對於 Convert 這種轉化語義來講,很多工具類中都有這樣的定義,這中 Convert 並不是業務級別上的接口定義,它隻是用於普通 bean 之間轉化屬性值的普通意義上的接口定義,所以我們應該更多的去讀其他含有 Convert 轉化語義的代碼。

我仔細閱讀瞭一下 GUAVA 的源碼,發現瞭 com.google.common.base.Convert 這樣的定義:

public abstract class Converter<A, B> implements Function<A, B> {
    protected abstract B doForward(A a);
    protected abstract A doBackward(B b);
    //其他略
}

從源碼可以瞭解到,GUAVA 中的 Convert 可以完成正向轉化和逆向轉化,繼續修改我們 DTO 中轉化的這段代碼:

private static class UserInputDTOConvert implements DTOConvert<UserInputDTO,User> {
        @Override
        public User convert(UserInputDTO userInputDTO) {
                User user = new User();
                BeanUtils.copyProperties(userInputDTO,user);
                return user;
        }
}

修改後:

private static class UserInputDTOConvert extends Converter<UserInputDTO, User> {
         @Override
         protected User doForward(UserInputDTO userInputDTO) {
                 User user = new User();
                 BeanUtils.copyProperties(userInputDTO,user);
                 return user;
         }

         @Override
         protected UserInputDTO doBackward(User user) {
                 UserInputDTO userInputDTO = new UserInputDTO();
                 BeanUtils.copyProperties(user,userInputDTO);
                 return userInputDTO;
         }
 }

看瞭這部分代碼以後,你可能會問,那逆向轉化會有什麼用呢?其實我們有很多小的業務需求中,入參和出參是一樣的,那麼我們變可以輕松的進行轉化,我將上邊所提到的 UserInputDTO 和 UserOutputDTO 都轉成 UserDTO 展示給大傢。

DTO:

public class UserDTO {
    private String username;
    private int age;
    public String getUsername() {
            return username;
    }
    public void setUsername(String username) {
            this.username = username;
    }
    public int getAge() {
            return age;
    }
    public void setAge(int age) {
            this.age = age;
    }
    public User convertToUser(){
            UserDTOConvert userDTOConvert = new UserDTOConvert();
            User convert = userDTOConvert.convert(this);
            return convert;
    }
    public UserDTO convertFor(User user){
            UserDTOConvert userDTOConvert = new UserDTOConvert();
            UserDTO convert = userDTOConvert.reverse().convert(user);
            return convert;
    }
    private static class UserDTOConvert extends Converter<UserDTO, User> {
            @Override
            protected User doForward(UserDTO userDTO) {
                    User user = new User();
                    BeanUtils.copyProperties(userDTO,user);
                    return user;
            }
            @Override
            protected UserDTO doBackward(User user) {
                    UserDTO userDTO = new UserDTO();
                    BeanUtils.copyProperties(user,userDTO);
                    return userDTO;
            }
    }
}

API:

@PostMapping
 public UserDTO addUser(UserDTO userDTO){
         User user =  userDTO.convertToUser();
         User saveResultUser = userService.addUser(user);
         UserDTO result = userDTO.convertFor(saveResultUser);
         return result;
 }

當然,上述隻是表明瞭轉化方向的正向或逆向,很多業務需求的出參和入參的 DTO 對象是不同的,那麼你需要更明顯的告訴程序:逆向是無法調用的:

private static class UserDTOConvert extends Converter<UserDTO, User> {
         @Override
         protected User doForward(UserDTO userDTO) {
                 User user = new User();
                 BeanUtils.copyProperties(userDTO,user);
                 return user;
         }

         @Override
         protected UserDTO doBackward(User user) {
                 throw new AssertionError("不支持逆向轉化方法!");
         }
 }

看一下 doBackward 方法,直接拋出瞭一個斷言異常,而不是業務異常,這段代碼告訴代碼的調用者,這個方法不是準你調用的,如果你調用,我就”斷言”你調用錯誤瞭。

關於異常處理的更詳細介紹,可以參考我之前的文章:如何優雅的設計 Java 異常(http://lrwinx.github.io/2016/04/28/%E5%A6%82%E4%BD%95%E4%BC%98%E9%9B%85%E7%9A%84%E8%AE%BE%E8%AE%A1java%E5%BC%82%E5%B8%B8/) ,應該可以幫你更好的理解異常。

Bean 的驗證

如果你認為我上邊寫的那個添加用戶 API 寫的已經非常完美瞭,那隻能說明你還不是一個優秀的程序員。我們應該保證任何數據的入參到方法體內都是合法的。

為什麼要驗證

很多人會告訴我,如果這些 API 是提供給前端進行調用的,前端都會進行驗證啊,你為什還要驗證?

其實答案是這樣的,我從不相信任何調用我 API 或者方法的人,比如前端驗證失敗瞭,或者某些人通過一些特殊的渠道(比如 Charles 進行抓包),直接將數據傳入到我的 API,那我仍然進行正常的業務邏輯處理,那麼就有可能產生臟數據!

“對於臟數據的產生一定是致命”,這句話希望大傢牢記在心,再小的臟數據也有可能讓你找幾個通宵!

jsr 303驗證

hibernate 提供的 jsr 303 實現,我覺得目前仍然是很優秀的,具體如何使用,我不想講,因為谷歌上你可以搜索出很多答案!

再以上班的 API 實例進行說明,我們現在對 DTO 數據進行檢查:

public class UserDTO {
    @NotNull
    private String username;
    @NotNull
    private int age;
        //其他代碼略
}

API 驗證:

@PostMapping
    public UserDTO addUser(@Valid UserDTO userDTO){
            User user =  userDTO.convertToUser();
            User saveResultUser = userService.addUser(user);
            UserDTO result = userDTO.convertFor(saveResultUser);
            return result;
    }

我們需要將驗證結果傳給前端,這種異常應該轉化為一個 api 異常(帶有錯誤碼的異常)。

@PostMapping
public UserDTO addUser(@Valid UserDTO userDTO, BindingResult bindingResult){
     checkDTOParams(bindingResult);

     User user =  userDTO.convertToUser();
     User saveResultUser = userService.addUser(user);
     UserDTO result = userDTO.convertFor(saveResultUser);
     return result;
}
private void checkDTOParams(BindingResult bindingResult){
     if(bindingResult.hasErrors()){
             //throw new 帶驗證碼的驗證錯誤異常
     }
}

BindingResult 是 Spring MVC 驗證 DTO 後的一個結果集,可以參考spring 官方文檔(http://spring.io/)。

檢查參數後,可以拋出一個“帶驗證碼的驗證錯誤異常”,具體異常設計可以參考如何優雅的設計 Java 異常(http://lrwinx.github.io/2016/04/28/%E5%A6%82%E4%BD%95%E4%BC%98%E9%9B%85%E7%9A%84%E8%AE%BE%E8%AE%A1java%E5%BC%82%E5%B8%B8/)。

擁抱 lombok

上邊的 DTO 代碼,已經讓我看的很累瞭,我相信讀者也是一樣,看到那麼多的 Getter 和 Setter 方法,太煩躁瞭,那時候有什麼方法可以簡化這些呢。

請擁抱 lombok,它會幫助我們解決一些讓我們很煩躁的問題

去掉 Setter 和 Getter

其實這個標題,我不太想說,因為網上太多,但是因為很多人告訴我,他們根本就不知道 lombok 的存在,所以為瞭讓讀者更好的學習,我願意寫這樣一個例子:

@Setter
@Getter
public class UserDTO {
    @NotNull
    private String username;
    @NotNull
    private int age;
    public User convertToUser(){
        UserDTOConvert userDTOConvert = new UserDTOConvert();
        User convert = userDTOConvert.convert(this);
        return convert;
    }
    public UserDTO convertFor(User user){
        UserDTOConvert userDTOConvert = new UserDTOConvert();
        UserDTO convert = userDTOConvert.reverse().convert(user);
        return convert;
    }
    private static class UserDTOConvert extends Converter<UserDTO, User> {
        @Override
        protected User doForward(UserDTO userDTO) {
            User user = new User();
            BeanUtils.copyProperties(userDTO,user);
            return user;
        }
        @Override
        protected UserDTO doBackward(User user) {
            throw new AssertionError("不支持逆向轉化方法!");
        }
    }
}

看到瞭吧,煩人的 Getter 和 Setter 方法已經去掉瞭。

但是上邊的例子根本不足以體現 lombok 的強大。我希望寫一些網上很難查到,或者很少人進行說明的 lombok 的使用以及在使用時程序語義上的說明。

比如:@Data,@AllArgsConstructor,@NoArgsConstructor..這些我就不進行一一說明瞭,請大傢自行查詢資料。

bean 中的鏈式風格

什麼是鏈式風格?我來舉個例子,看下面這個 Student 的 bean:

public class Student {
    private String name;
    private int age;
    public String getName() {
        return name;
    }
    public Student setName(String name) {
        this.name = name;
        return this;
    }
    public int getAge() {
        return age;
    }
    public Student setAge(int age) {
        return this;
    }
}

仔細看一下 set 方法,這樣的設置便是 chain 的 style,調用的時候,可以這樣使用:

Student student = new Student()
        .setAge(24)
        .setName("zs");

相信合理使用這樣的鏈式代碼,會更多的程序帶來很好的可讀性,那看一下如果使用 lombok 進行改善呢,請使用 @Accessors(chain = true),看如下代碼:

@Accessors(chain = true)
@Setter
@Getter
public class Student {
    private String name;
    private int age;
}

這樣就完成瞭一個對於 bean 來講很友好的鏈式操作。

靜態構造方法

靜態構造方法的語義和簡化程度真的高於直接去 new 一個對象。比如 new 一個 List 對象,過去的使用是這樣的:

List<String> list = new ArrayList<>();

看一下 guava 中的創建方式:

List<String> list = Lists.newArrayList();

Lists 命名是一種約定(俗話說:約定優於配置),它是指 Lists 是 List 這個類的一個工具類,那麼使用 List 的工具類去產生 List,這樣的語義是不是要比直接 new 一個子類來的更直接一些呢,答案是肯定的,再比如如果有一個工具類叫做 Maps,那你是否想到瞭創建 Map 的方法呢:

HashMap<String, String> objectObjectHashMap = Maps.newHashMap();

好瞭,如果你理解瞭我說的語義,那麼,你已經向成為 Java 程序員更近瞭一步瞭。

再回過頭來看剛剛的 Student,很多時候,我們去寫 Student 這個 bean 的時候,他會有一些必輸字段,比如 Student 中的 name 字段,一般處理的方式是將 name 字段包裝成一個構造方法,隻有傳入 name 這樣的構造方法,才能創建一個 Student 對象。

接上上邊的靜態構造方法和必傳參數的構造方法,使用 lombok 將更改成如下寫法(@RequiredArgsConstructor 和 @NonNull):

@Accessors(chain = true)
@Setter
@Getter
@RequiredArgsConstructor(staticName = "ofName")
public class Student {
    @NonNull private String name;
    private int age;
}

測試代碼:

Student student = Student.ofName("zs");

這樣構建出的 bean 語義是否要比直接 new 一個含參的構造方法(包含  name 的構造方法)要好很多。

當然,看過很多源碼以後,我想相信將靜態構造方法 ofName 換成 of 會先的更加簡潔:

@Accessors(chain = true)
@Setter
@Getter
@RequiredArgsConstructor(staticName = "of")
public class Student {
        @NonNull private String name;
        private int age;
}

測試代碼:

Student student = Student.of("zs");

當然他仍然是支持鏈式調用的:

Student student = Student.of("zs").setAge(24);

這樣來寫代碼,真的很簡潔,並且可讀性很強。

使用 builder

Builder 模式我不想再多解釋瞭,讀者可以看一下《Head First》(設計模式) 的建造者模式。

今天其實要說的是一種變種的 builder 模式,那就是構建 bean 的 builder 模式,其實主要的思想是帶著大傢一起看一下 lombok 給我們帶來瞭什麼。

看一下 Student 這個類的原始 builder 狀態:

public class Student {
    private String name;
    private int age;
    public String getName() {
            return name;
    }
    public void setName(String name) {
            this.name = name;
    }
    public int getAge() {
            return age;
    }
    public void setAge(int age) {
            this.age = age;
    }
    public static Builder builder(){
            return new Builder();
    }
    public static class Builder{
            private String name;
            private int age;
            public Builder name(String name){
                    this.name = name;
                    return this;
            }
            public Builder age(int age){
                    this.age = age;
                    return this;
            }
            public Student build(){
                    Student student = new Student();
                    student.setAge(age);
                    student.setName(name);
                    return student;
            }
    }
}

調用方式:

Student student = Student.builder().name("zs").age(24).build();

這樣的 builder 代碼,讓我是在惡心難受,於是我打算用 lombok 重構這段代碼:

@Builder
public class Student {
    private String name;
    private int age;
}

調用方式:

Student student = Student.builder().name("zs").age(24).build();

代理模式

正如我們所知的,在程序中調用 rest 接口是一個常見的行為動作,如果你和我一樣使用過 spring 的 RestTemplate,我相信你會我和一樣,對他拋出的非 http 狀態碼異常深惡痛絕。

所以我們考慮將 RestTemplate 最為底層包裝器進行包裝器模式的設計:

public abstract class FilterRestTemplate implements RestOperations {
        protected volatile RestTemplate restTemplate;
        protected FilterRestTemplate(RestTemplate restTemplate){
                this.restTemplate = restTemplate;
        }
        //實現RestOperations所有的接口
}

然後再由擴展類對 FilterRestTemplate 進行包裝擴展:

public class ExtractRestTemplate extends FilterRestTemplate {
    private RestTemplate restTemplate;
    public ExtractRestTemplate(RestTemplate restTemplate) {
            super(restTemplate);
            this.restTemplate = restTemplate;
    }

    public <T> RestResponseDTO<T> postForEntityWithNoException(String url, Object request, Class<T> responseType, Object... uriVariables)
                    throws RestClientException {
            RestResponseDTO<T> restResponseDTO = new RestResponseDTO<T>();
            ResponseEntity<T> tResponseEntity;
            try {
                    tResponseEntity = restTemplate.postForEntity(url, request, responseType, uriVariables);
                    restResponseDTO.setData(tResponseEntity.getBody());
                    restResponseDTO.setMessage(tResponseEntity.getStatusCode().name());
                    restResponseDTO.setStatusCode(tResponseEntity.getStatusCodeValue());
            }catch (Exception e){
                    restResponseDTO.setStatusCode(RestResponseDTO.UNKNOWN_ERROR);
                    restResponseDTO.setMessage(e.getMessage());
                    restResponseDTO.setData(null);
            }
            return restResponseDTO;
    }
}

包裝器 ExtractRestTemplate 很完美的更改瞭異常拋出的行為,讓程序更具有容錯性。在這裡我們不考慮 ExtractRestTemplate 完成的功能,讓我們把焦點放在 FilterRestTemplate 上,“實現 RestOperations 所有的接口”,這個操作絕對不是一時半會可以寫完的,當時在重構之前我幾乎寫瞭半個小時,如下:

public abstract class FilterRestTemplate implements RestOperations {
    protected volatile RestTemplate restTemplate;
    protected FilterRestTemplate(RestTemplate restTemplate) {
            this.restTemplate = restTemplate;
    }
    @Override
    public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
            return restTemplate.getForObject(url,responseType,uriVariables);
    }
    @Override
    public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
            return restTemplate.getForObject(url,responseType,uriVariables);
    }
    @Override
    public <T> T getForObject(URI url, Class<T> responseType) throws RestClientException {
            return restTemplate.getForObject(url,responseType);
    }
    @Override
    public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
            return restTemplate.getForEntity(url,responseType,uriVariables);
    }
    //其他實現代碼略。。。
}

我相信你看瞭以上代碼,你會和我一樣覺得惡心反胃,後來我用 lombok 提供的代理註解優化瞭我的代碼(@Delegate):

@AllArgsConstructor
public abstract class FilterRestTemplate implements RestOperations {
    @Delegate
    protected volatile RestTemplate restTemplate;
}

這幾行代碼完全替代上述那些冗長的代碼。

是不是很簡潔,做一個擁抱 lombok 的程序員吧。

重構

需求案例

項目需求

項目開發階段,有一個關於下單發貨的需求:如果今天下午 3 點前進行下單,那麼發貨時間是明天,如果今天下午 3 點後進行下單,那麼發貨時間是後天,如果被確定的時間是周日,那麼在此時間上再加 1 天為發貨時間。

思考與重構

我相信這個需求看似很簡單,無論怎麼寫都可以完成。

很多人可能看到這個需求,就動手開始寫 Calendar 或 Date 進行計算,從而完成需求。

而我給的建議是,仔細考慮如何寫代碼,然後再去寫,不是說所有的時間操作都用 Calendar 或 Date 去解決,一定要看場景。

對於時間的計算我們要考慮 joda-time 這種類似的成熟時間計算框架來寫代碼,它會讓代碼更加簡潔和易讀。

請讀者先考慮這個需求如何用 Java 代碼完成,或先寫一個你覺得完成這個代碼的思路,再來看我下邊的代碼,這樣,你的收獲會更多一些:

final DateTime DISTRIBUTION_TIME_SPLIT_TIME = new DateTime().withTime(15,0,0,0);
private Date calculateDistributionTimeByOrderCreateTime(Date orderCreateTime){
    DateTime orderCreateDateTime = new DateTime(orderCreateTime);
    Date tomorrow = orderCreateDateTime.plusDays(1).toDate();
    Date theDayAfterTomorrow = orderCreateDateTime.plusDays(2).toDate();
    return orderCreateDateTime.isAfter(DISTRIBUTION_TIME_SPLIT_TIME) ? wrapDistributionTime(theDayAfterTomorrow) : wrapDistributionTime(tomorrow);
}
private Date wrapDistributionTime(Date distributionTime){
    DateTime currentDistributionDateTime = new DateTime(distributionTime);
    DateTime plusOneDay = currentDistributionDateTime.plusDays(1);
    boolean isSunday = (DateTimeConstants.SUNDAY == currentDistributionDateTime.getDayOfWeek());
    return isSunday ? plusOneDay.toDate() : currentDistributionDateTime.toDate() ;
}

讀這段代碼的時候,你會發現,我將判斷和有可能出現的不同結果都當做一個變量,最終做一個三目運算符的方式進行返回,這樣的優雅和可讀性顯而易見,當然這樣的代碼不是一蹴而就的,我優化瞭 3 遍產生的以上代碼。讀者可根據自己的代碼和我寫的代碼進行對比。

提高方法

如果你做瞭 3 年+的程序員,我相信像如上這樣的需求,你很輕松就能完成,但是如果你想做一個會寫 Java 的程序員,就好好的思考和重構代碼吧。

寫代碼就如同寫字一樣,同樣的字,大傢都會寫,但是寫出來是否好看就不一定瞭。如果想把程序寫好,就要不斷的思考和重構,敢於嘗試,敢於創新,不要因循守舊,一定要做一個優秀的 Java 程序員。

提高代碼水平最好的方法就是有條理的重構!(註意:是有條理的重構)

設計模式

設計模式就是工具,而不是提現你是否是高水平程序員的一個指標。

我經常會看到某一個程序員興奮的大喊,哪個程序哪個點我用到瞭設計模式,寫的多麼多麼優秀,多麼多麼好。我仔細去翻閱的時候,卻發現有很多是過度設計的。

業務驅動技術 or 技術驅動業務

業務驅動技術 or 技術驅動業務 ?其實這是一個一直在爭論的話題,但是很多人不這麼認為,我覺得就是大傢不願意承認罷瞭。我來和大傢大概分析一下作為一個 Java 程序員,我們應該如何判斷自己所處於的位置.

業務驅動技術: 如果你所在的項目是一個收益很小或者甚至沒有收益的項目,請不要搞其他創新的東西,不要驅動業務要如何如何做,而是要熟知業務現在的痛點是什麼?如何才能幫助業務盈利或者讓項目更好,更順利的進行。

技術驅動業務: 如果你所在的項目是一個很牛的項目,比如淘寶這類的項目,我可以在滿足業務需求的情況下,和業務溝通,使用什麼樣的技術能更好的幫助業務創造收益,比如說下單的時候要進隊列,可能幾分鐘之後訂單狀態才能處理完成,但是會讓用戶有更流暢的體驗,賺取更多的訪問流量,那麼我相信業務願意被技術驅動,會同意訂單的延遲問題,這樣便是技術驅動業務。

我相信大部分人還都處於業務驅動技術的方向吧。

所以你既然不能驅動業務,那就請擁抱業務變化吧。

代碼設計

一直在做 Java 後端的項目,經常會有一些變動,我相信大傢也都遇到過。

比如當我們寫一段代碼的時候,我們考慮將需求映射成代碼的狀態模式,突然有一天,狀態模式裡邊又添加瞭很多行為變化的東西,這時候你就撓頭瞭,你硬生生的將狀態模式中添加過多行為和變化。

慢慢的你會發現這些狀態模式,其實更像是一簇算法,應該使用策略模式,這時你應該已經暈頭轉向瞭。

說瞭這麼多,我的意思是,隻要你覺得合理,就請將狀態模式改為策略模式吧,所有的模式並不是憑空想象出來的,都是基於重構。

Java 編程中沒有銀彈,請擁抱業務變化,一直思考重構,你就有一個更好的代碼設計!

你真的優秀嗎?

真不好意思,我取瞭一個這麼無聊的標題。

國外流行一種編程方式,叫做結對編程,我相信國內很多公司都沒有這麼做,我就不在講述結對編程帶來的好處瞭,其實就是一邊 code review,一邊互相提高的一個過程。既然做不到這個,那如何讓自己活在自己的世界中不斷提高呢?

“平時開發的時候,做出的代碼總認為是正確的,而且寫法是完美的。”,我相信這是大部分人的心聲,還回到剛剛的問題,如何在自己的世界中不斷提高呢?

答案就是:

  • 多看成熟框架的源碼
  • 多回頭看自己的代碼
  • 勤於重構

你真的優秀嗎?如果你每周都完成瞭學習源碼,回頭看自己代碼,然後勤於重構,我認為你就真的很優秀瞭。

即使也許你隻是剛剛入門,但是一直堅持,你就是一個真的會寫java代碼的程序員瞭。

技能

UML

不想多討論 UML 相關的知識,但是我覺得你如果真的會寫 Java,請先學會表達自己,UML 就是你說話的語言,做一名優秀的 Java 程序員,請至少學會這兩種 UML 圖:

  • 類圖
  • 時序圖

clean code

我認為保持代碼的簡潔和可讀性是代碼的最基本保證,如果有一天為瞭程序的效率而降低瞭這兩點,我認為是可以諒解的,除此之外,沒有任何理由可以讓你任意揮霍你的代碼。

  • 讀者可以看一下 Robert C. Martin 出版的《Clean Code》(代碼整潔之道) 這本書
  • 可以參考美團文章聊聊 clean code(http://tech.meituan.com/clean-code.html);
  • 也可以看一下阿裡的 Java 編碼規范(https://yq.aliyun.com/articles/69327?spm=5176.100239.topwz.1.om5dRN)。

無論如何,請保持你的代碼的整潔。

Linux 基礎命令

這點其實和會寫 Java 沒有關系,但是 Linux 很多時候確實承載運行 Java 的容器,請學好 Linux 的基礎命令。

參考鳥哥的《Linux私房菜》

總結

Java 是一個大體系,今天討論並未涉及框架和架構相關知識,隻是討論如何寫好代碼。

本文從寫 Java 程序的小方面一直寫到大方面,來闡述瞭如何才能寫好 Java 程序,並告訴讀者們如何才能提高自身的編碼水平。

到此這篇關於分享令人目瞪口呆的 Java 代碼技巧的文章就介紹到這瞭,更多相關Java 代碼技巧內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: