SpringBoot @ModelAttribute 用法

kenx發表於2021-08-09
Spring Boot

前言

專案中遇到這麼一個使用場景，使用者的登入資訊給予token儲存，在需要有登入資訊的地方，每次都要去獲取使用者Id,但每次在請求方法中去獲取使用者資訊，程式碼重複，冗餘，很low於是想到了用@ModelAttribute 這個屬性

使用場景

不用@ModelAttribute 時候在需要使用者資訊的請求中每次需要單獨獲取使用者資訊

  String token = request.getAttribute("token").toString();
   User LoginUser = tokenService.decodeToken(token);

程式碼重複每次都需要單獨去寫，

於是我想到了去優化一下程式碼，在需要使使用者資訊的controller中寫一個公共方法，每次直接獲取就可以了

private User gerUserInfo(HttpServletRequest request){
        String token = request.getAttribute("token").toString();
        User LoginUser = tokenService.decodeToken(token);
        return LoginUser;
    }

這樣寫程式碼是簡化了一些，但是沒什麼特別大的改觀，還是要在每個需求使用者資訊的請求Controller中呼叫此方法取獲取用使用者資訊，如果多個Controller需要獲取使用者資訊的話還需要重複寫

也是想到繼承，寫一個公共的controller叫BaseController，每次在需要使用者資訊的controller中繼承BaseController 然後在呼叫就可以了

@RestController
public class BaseController {
    @Autowired
    private TokenService tokenService;
   

   private User gerUserInfo(HttpServletRequest request){
        String token = request.getAttribute("token").toString();
        User LoginUser = tokenService.decodeToken(token);
        return LoginUser;
    }
}

這樣看上去似乎比之前兩種做法都簡單便捷很多，在需要使用使用者資訊的controller中直接繼承呼叫就可以啦，但是並沒有根本解決我們的問題，我們還是需要寫重複程式碼，在每個controller單獨獲取使用者資訊，這是最優嘛？並不是！！！

其實呢springboot提供@ModelAttribute這個註解屬性使用這個通過引數注入就可獲取啦

我們把上面的稍微調整一下如：

@RestController
public class BaseController {
    @Autowired
    private TokenService tokenService;
 

    @ModelAttribute
    public void userInfo(ModelMap modelMap, HttpServletRequest request) {
        String token = request.getAttribute("token").toString();
        User LoginUser = tokenService.decodeToken(token);
    
        modelMap.addAttribute("LoginUser", LoginUser);
        modelMap.addAttribute("userId", LoginUser.getUserId());

    }
}

然後在需要使用使用者資訊的controller中進行引數對映就行啦

@ApiOperation(value = "使用者快過期優惠卷資訊",tags = "優惠卷介面")
    @GetMapping("/expiredCoupon")
    public List<Coupon> userExpiredCoupon(@ModelAttribute("userId") @ApiParam(hidden = true) String userId){
        return couponService.getUserExpiredCoupon(userId);
    }

@GetMapping("/info")
    @ApiOperation("獲取使用者資訊")
    public User getUseInfo(@ModelAttribute("LoginUser") User user) {
        return user;
    }

這樣使用者資訊通過形參直接注入到controller中，我們直接在請求中使用就可以啦

@ModelAttribute詳解

  1. 被@ModelAttribute註釋的方法會在此controller每個方法執行前被執行
    標註在方法上面的註解，將方法返回的物件儲存在model中，該方法在這個控制器其他對映方法執行之前呼叫
  2. @ModelAttribute註釋一個方法的引數 從model中獲取引數@ModelAttribute("LoginUser") User user引數user的值來源於BaseControlleruserInfo()方法中的model屬性

具體更詳細使用參考 @ModelAttribute註解的使用總結

相關文章