SpringBoot @ModelAttribute 用法

前言

項目中遇到這么一個使用場景，用戶的登錄信息給予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注解的使用總結