作為一名 Java程序員,對(duì) Controller肯定不陌生,它是與外部客戶端通信的入口,比如常見的 REST 操作(GET、PUT、POST、DELETE等),那么,Controller里面應(yīng)該如何編寫才算優(yōu)雅呢?
其實(shí),一個(gè)優(yōu)雅的 Controller,里面的代碼主要包含下面 6個(gè)部分:
下面一一講解這 6個(gè)部分:
接收 HTTP(s)請(qǐng)求是 Controller的入口,這里以查詢用戶信息為例進(jìn)行說明,如下代碼:
@RestControllerpublic class UserController { @GetMapping("/user/{userId}") public void getUserById(@PathVariable String userId) { // 業(yè)務(wù)邏輯 }}
在上面的示例中,我們使用 URL/user/{id}接收用戶發(fā)出的 GET請(qǐng)求,然后通過getUserById方法進(jìn)行真實(shí)的業(yè)務(wù)處理。通過上面的代碼,一個(gè)請(qǐng)求就被 Controller層成功接收了。
接收到請(qǐng)求后,一般需要對(duì)請(qǐng)求參數(shù)進(jìn)行解析,如下示例代碼:
@RestControllerpublic 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}
上述示例代碼將請(qǐng)求的 body映射到 User對(duì)象上,因此,請(qǐng)求的 body體應(yīng)該是:
{ "nickname": "huahua", "age": "18"}
在 SpringMVC 中,常見的參數(shù)類型及其用途如下:
直接接收原始的 HTTP請(qǐng)求和響應(yīng)對(duì)象,HttpServletRequest 和 HttpServletResponse
@RequestMapping("/test")public void example(HttpServletRequest request, HttpServletResponse response) { // 處理請(qǐng)求和響應(yīng)}
用于獲取 URL 路徑中的動(dòng)態(tài)部分。
@RequestMapping("/user/{id}")public String getUser(@PathVariable("id") String userId) { // 使用 userId 進(jìn)行處理 return "userDetail";}
用于獲取 URL 查詢參數(shù)或表單數(shù)據(jù)。
@RequestMapping("/search")public String search(@RequestParam("query") String query) { // 使用 query 進(jìn)行搜索 return "searchResults";}
用于接收請(qǐng)求體中的數(shù)據(jù),常用于處理 JSON 或 XML 格式的數(shù)據(jù)。
@RequestMapping(value = "/create", method = RequestMethod.POST)public String create(@RequestBody User user) { // 處理 user 對(duì)象 return "user";}
用于綁定表單數(shù)據(jù)到模型對(duì)象。
@RequestMapping("/register")public String register(@ModelAttribute User user) { // 處理 user 對(duì)象 return "user";}
用于訪問會(huì)話中的屬性。
@RequestMapping("/profile")public String profile(@SessionAttribute("user") User user) { // 處理會(huì)話中的 user 對(duì)象 return "profile";}
用于訪問 HTTP 請(qǐng)求頭信息。
@RequestMapping("/headers")public String headers(@RequestHeader("User-Agent") String userAgent) { // 使用 userAgent 進(jìn)行處理 return "headerInfo";}
用于訪問 Cookie 的值。
@RequestMapping("/cookies")public String cookies(@CookieValue("sessionId") String sessionId) { // 使用 sessionId 進(jìn)行處理 return sessionId;}
可以通過實(shí)現(xiàn) HandlerMethodArgumentResolver接口來自定義參數(shù)解析邏輯。
@RequestMapping("/custom")public String custom(CustomObject customObject) {// 使用自定義對(duì)象進(jìn)行處理 return "";}
請(qǐng)求參數(shù)的驗(yàn)證需要在 Controller層完成,如下代碼,對(duì) nickname進(jìn)行判空處理,參數(shù)驗(yàn)證一般有 2種方式:
// 原始方式校驗(yàn)參數(shù)@RestControllerpublic class UserController { @PostMapping("/user/register") public void getGradeById(@RequestBody User user) { // 代碼邏輯 if (StringUtils.isBlank(user.getNickname)) { throw new Exception("Nickname is required."); } }}
或者使用 Spring validation驗(yàn)證機(jī)制,Controller需要增加@Validated注解,User對(duì)象中增加@NotBlank注解。
// 借助Spring validation方式校驗(yàn)參數(shù)@RestControllerpublic 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)用 UserService.register()進(jìn)行注冊(cè)業(yè)務(wù)處理:
@RestControllerpublic 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)用注冊(cè)的業(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ù)方法是寫一個(gè)大而全的方法?還是需要按業(yè)務(wù)歸類?
遵守一個(gè)原則:有強(qiáng)關(guān)聯(lián)性的邏輯放在一個(gè)service方法內(nèi),沒有強(qiáng)關(guān)聯(lián)性的單令拎出來。
這里以用戶注冊(cè)之后需要新人發(fā)券為例進(jìn)行說明:
大而全的方法:
@PostMapping("/user/register") public void getGradeById(@Validated @RequestBody User user) { // 調(diào)用注冊(cè)的業(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)用注冊(cè)的業(yè)務(wù)方法 userService.register(user); coupon.sendCoupon(userId); }
如下代碼,調(diào)用 UserService.register()進(jìn)行注冊(cè)業(yè)務(wù)處理:
@RestControllerpublic 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)用注冊(cè)的業(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}
比如上述過程在 userService.regist(user);出現(xiàn)異常時(shí),可以做一個(gè)try-catch,然后在 Controller層封裝有業(yè)務(wù)意思的異常信息:
@RestControllerpublic class UserController { private final UserService userService; @PostMapping("/user/register") public UserResponse getGradeById(@Validated @RequestBody User user) { // 調(diào)用注冊(cè)的業(yè)務(wù)方法 try { String userId = userService.regist(user); } catch (Exception e) { throw new CustomException(); } return new UserResponse(userId, user.getNickname); }}
看過很多代碼,業(yè)務(wù)邏輯全部寫在 Controller層,并不能說這樣的做法是錯(cuò)的,但是看起來很別扭,不優(yōu)雅!因此,建議在編寫代碼時(shí),最好能遵守一個(gè)比較好的規(guī)范,比如常見的SOLID規(guī)范。
SOLID 實(shí)際上是五個(gè)設(shè)計(jì)原則首字母的縮寫,它們分別是:
另外,建議我們技術(shù)人員平時(shí)多去閱讀一些優(yōu)秀開源框架,學(xué)習(xí)他們的設(shè)計(jì)思想,代碼規(guī)范,相信我:養(yǎng)成一個(gè)良好的編碼規(guī)范,絕對(duì)受益頗多!
本文鏈接:http://www.tebozhan.com/showinfo-26-96045-0.html如何編寫優(yōu)雅的 Controller 代碼?
聲明:本網(wǎng)頁內(nèi)容旨在傳播知識(shí),若有侵權(quán)等問題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系,我們將在第一時(shí)間刪除處理。郵件:2376512515@qq.com