如何編寫優(yōu)雅的 Controller 代碼？
作為一名 Java程序員，對 Controller肯定不陌生，它是與外部客戶端通信的入口，比如常見的 REST 操作（GET、PUT、POST、DELETE等），那么，Controller里面應(yīng)該如何編寫才算優(yōu)雅呢？
其實，一個優(yōu)雅的 Controller，里面的代碼主要包含下面 6個部分：
- 接收 HTTP(s)請求
- 解析請求參數(shù)
- 驗證請求參數(shù)
- 調(diào)用業(yè)務(wù)方法
- 組織返回數(shù)據(jù)
- 統(tǒng)一異常處理
下面一一講解這 6個部分：
一、接收 HTTP(s)請求
接收 HTTP(s)請求是 Controller的入口，這里以查詢用戶信息為例進行說明，如下代碼：
@RestController
public class UserController {
@GetMapping("/user/{userId}")
public void getUserById(@PathVariable String userId) {
// 業(yè)務(wù)邏輯
}
}在上面的示例中，我們使用 URL/user/{id}接收用戶發(fā)出的 GET請求，然后通過getUserById方法進行真實的業(yè)務(wù)處理。通過上面的代碼，一個請求就被 Controller層成功接收了。
二、解析請求參數(shù)
接收到請求后，一般需要對請求參數(shù)進行解析，如下示例代碼：
@RestController
public class UserController {
@PostMapping("/user/register")
public void getGradeById(@RequestBody User user) {
// 代碼邏輯
}
}
public class User {
private String nickname;
private Integer age;
// getters and setters and constructors
}上述示例代碼將請求的 body映射到 User對象上，因此，請求的 body體應(yīng)該是：
{
"nickname": "huahua",
"age": "18"
}在 SpringMVC 中，常見的參數(shù)類型及其用途如下：
1.原始 HTTP請求和響應(yīng)對象
直接接收原始的 HTTP請求和響應(yīng)對象，HttpServletRequest 和 HttpServletResponse
@RequestMapping("/test")
public void example(HttpServletRequest request, HttpServletResponse response) {
// 處理請求和響應(yīng)
}2.路徑變量 (@PathVariable)
用于獲取 URL 路徑中的動態(tài)部分。
@RequestMapping("/user/{id}")
public String getUser(@PathVariable("id") String userId) {
// 使用 userId 進行處理
return "userDetail";
}3.請求參數(shù) (@RequestParam)
用于獲取 URL 查詢參數(shù)或表單數(shù)據(jù)。
@RequestMapping("/search")
public String search(@RequestParam("query") String query) {
// 使用 query 進行搜索
return "searchResults";
}4.請求體 (@RequestBody)
用于接收請求體中的數(shù)據(jù)，常用于處理 JSON 或 XML 格式的數(shù)據(jù)。
@RequestMapping(value = "/create", method = RequestMethod.POST)
public String create(@RequestBody User user) {
// 處理 user 對象
return "user";
}5.模型屬性 (@ModelAttribute)
用于綁定表單數(shù)據(jù)到模型對象。
@RequestMapping("/register")
public String register(@ModelAttribute User user) {
// 處理 user 對象
return "user";
}6.會話屬性 (@SessionAttribute)
用于訪問會話中的屬性。
@RequestMapping("/profile")
public String profile(@SessionAttribute("user") User user) {
// 處理會話中的 user 對象
return "profile";
}7.請求頭 (@RequestHeader)
用于訪問 HTTP 請求頭信息。
@RequestMapping("/headers")
public String headers(@RequestHeader("User-Agent") String userAgent) {
// 使用 userAgent 進行處理
return "headerInfo";
}8.Cookie 值 (@CookieValue)
用于訪問 Cookie 的值。
@RequestMapping("/cookies")
public String cookies(@CookieValue("sessionId") String sessionId) {
// 使用 sessionId 進行處理
return sessionId;
}9.自定義參數(shù)解析器
可以通過實現(xiàn) HandlerMethodArgumentResolver接口來自定義參數(shù)解析邏輯。
@RequestMapping("/custom")
public String custom(CustomObject customObject) {
// 使用自定義對象進行處理
return "";
}三、驗證請求參數(shù)
請求參數(shù)的驗證需要在 Controller層完成，如下代碼，對 nickname進行判空處理，參數(shù)驗證一般有 2種方式：
- 原始方式，這種方式比較靈活，如果需要對參數(shù)進行一些邏輯計算后再校驗；
- 借助三方工具，比如 Spring validation，javax validation等，這種方式靈活度會低一些，但是更優(yōu)雅；
// 原始方式校驗參數(shù)
@RestController
public class UserController {
@PostMapping("/user/register")
public void getGradeById(@RequestBody User user) {
// 代碼邏輯
if (StringUtils.isBlank(user.getNickname)) {
throw new Exception("Nickname is required.");
}
}
}或者使用 Spring validation驗證機制，Controller需要增加@Validated注解，User對象中增加@NotBlank注解。
// 借助Spring validation方式校驗參數(shù)
@RestController
public class UserController {
@PostMapping("/user/register")
public void getGradeById(@Validated @RequestBody User user) {
// 代碼邏輯
}
}
public class User {
@NotBlank(message = "Nickname is required.")
private String nickname;
private Integer age;
// getters and setters and constructors
}四、調(diào)用業(yè)務(wù)方法
如下代碼，調(diào)用 UserService.register()進行注冊業(yè)務(wù)處理：
@RestController
public class UserController {
private final UserService userService;
public UserController(UserService userService) {
this.userService = userService;
}
@PostMapping("/user/register")
public void getGradeById(@Validated @RequestBody User user) {
// 調(diào)用注冊的業(yè)務(wù)方法
userService.register(user);
}
}
public class User {
@NotBlank(message = "Nickname is required.")
private String nickname;
private Integer age;
// getters and setters and constructors
}關(guān)于調(diào)用業(yè)務(wù)方法，這里的業(yè)務(wù)方法是寫一個大而全的方法？還是需要按業(yè)務(wù)歸類？
遵守一個原則：有強關(guān)聯(lián)性的邏輯放在一個service方法內(nèi)，沒有強關(guān)聯(lián)性的單令拎出來。
這里以用戶注冊之后需要新人發(fā)券為例進行說明：
大而全的方法：
@PostMapping("/user/register")
public void getGradeById(@Validated @RequestBody User user) {
// 調(diào)用注冊的業(yè)務(wù)方法
userService.doRegister(user);
}
public String doRegister(Uswr user){
String userId = userService.register(user);
coupon.sendCoupon(userId);
// 其他業(yè)務(wù)邏輯
return userId;
}業(yè)務(wù)歸類：
@PostMapping("/user/register")
public void getGradeById(@Validated @RequestBody User user) {
// 調(diào)用注冊的業(yè)務(wù)方法
userService.register(user);
coupon.sendCoupon(userId);
}五、組織返回數(shù)據(jù)
如下代碼，調(diào)用 UserService.register()進行注冊業(yè)務(wù)處理：
@RestController
public class UserController {
private final UserService userService;
public UserController(UserService userService) {
this.userService = userService;
}
@PostMapping("/user/register")
public UserResponse getGradeById(@Validated @RequestBody User user) {
// 調(diào)用注冊的業(yè)務(wù)方法
String userId = userService.regist(user);
return new UserResponse(userId, user.getNickname);
}
}
public class UserResponse {
private String userId;
private String nickname;
// getters and setters and constructors
}六、統(tǒng)一異常處理
比如上述過程在 userService.regist(user);出現(xiàn)異常時，可以做一個try-catch，然后在 Controller層封裝有業(yè)務(wù)意思的異常信息：
@RestController
public class UserController {
private final UserService userService;
@PostMapping("/user/register")
public UserResponse getGradeById(@Validated @RequestBody User user) {
// 調(diào)用注冊的業(yè)務(wù)方法
try {
String userId = userService.regist(user);
} catch (Exception e) {
throw new CustomException();
}
return new UserResponse(userId, user.getNickname);
}
}建議和總結(jié)
看過很多代碼，業(yè)務(wù)邏輯全部寫在 Controller層，并不能說這樣的做法是錯的，但是看起來很別扭，不優(yōu)雅！因此，建議在編寫代碼時，最好能遵守一個比較好的規(guī)范，比如常見的SOLID規(guī)范。
SOLID 實際上是五個設(shè)計原則首字母的縮寫，它們分別是：
- 單一職責原則（Single responsibility principle, SRP）
- 開放封閉原則（Open–closed principle, OCP）
- Liskov 替換原則（Liskov substitution principle, LSP）
- 接口隔離原則（Interface segregation principle, ISP）
- 依賴倒置原則（Dependency inversion principle, DIP）
另外，建議我們技術(shù)人員平時多去閱讀一些優(yōu)秀開源框架，學(xué)習他們的設(shè)計思想，代碼規(guī)范，相信我：養(yǎng)成一個良好的編碼規(guī)范，絕對受益頗多！
