我們?cè)谑褂肧pring MVC開發(fā)API的時(shí)候，總會(huì)遇到這樣的情況，就是一些API需要登錄權(quán)限才能訪問，而且有些API是無需登錄權(quán)限，希望能夠以更加簡(jiǎn)單的方式管理這種差異，如果已經(jīng)登錄的信息也希望可以快速獲取登錄的信息。

通過Spring MVC的攔截器和注解就可以很好實(shí)現(xiàn)，下面就是我們希望的效果，調(diào)用/login/phone接口，無需登錄，調(diào)用/profile/show，就必須登錄，是否在上一層就報(bào)錯(cuò)，而且loginUserToken會(huì)填充登錄信息。

@RequireLogin(false)
@RequestMapping(value = "/login/phone")
fun loginPhone(phone: String, code: String): UserAccessToken {
}

@RequireLogin(true)
@RequestMapping(value = "/profile/show")
fun profileShow(@AutowiredLogin loginUserToken: UserAccessToken): User {
}

實(shí)現(xiàn)代碼

創(chuàng)建注解類

@Target(AnnotationTarget.VALUE_PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
annotation class AutowiredLogin ()

下面的代碼是用于判斷請(qǐng)求方法的參數(shù)，是否是帶有AutowiredLogin注解，如果帶有就返回session保存的UserAccessToken。

class LoginUserTokenArgumentResolver : HandlerMethodArgumentResolver {
    /**
     * 檢查解析器是否支持解析該參數(shù)
     */
    override fun supportsParameter(parameter: MethodParameter): Boolean {
        return parameter.getParameterAnnotation(AutowiredLogin::class.java) != null && parameter.parameterType == UserAccessToken::class.java
    }

    @Throws(Exception::class)
    override fun resolveArgument(parameter: MethodParameter, mavContainer: ModelAndViewContainer?, webRequest: NativeWebRequest, binderFactory: WebDataBinderFactory?): Any? {
        val request = webRequest.nativeRequest as HttpServletRequest
        val loginUserAccessToken = request.session.getAttribute("loginUserAccessToken")
        if (loginUserAccessToken != null && loginUserAccessToken is UserAccessToken) {
            return loginUserAccessToken
        }
        return null
    }
}

攔截器，用于獲取請(qǐng)求帶上的認(rèn)證參數(shù)，我這里是基于 Authorization Basic Auth 實(shí)現(xiàn)，開發(fā)者可以根據(jù)自己的認(rèn)證實(shí)現(xiàn)修改。

open class LoginInterceptor : HandlerInterceptorAdapter() {
    @Autowired
    lateinit var accountService: AccountService

    override fun preHandle(request: HttpServletRequest, response: HttpServletResponse, handler: Any): Boolean {
        if (handler is HandlerMethod) {
            val url = request.requestURI
            // 這里可以配置我們不需要攔截的路徑
            if (url.startsWith("boss") ||url.startsWith("druid") || url.startsWith("error")) {
                return super.preHandle(request, response, handler)
            }

            val requireLogin = handler.getMethodAnnotation(RequireLogin::class.java)
            if (requireLogin == null || requireLogin.value) {
                val authorization = request.getHeader("Authorization")
                if (authorization == null) {
                    // 直接拋出需要登錄的異常信息
                    throw ExceptionHelper.credentialNotFoundException()
                } else {
                    try {
                        val idAndToken = String(Base64.getDecoder().decode(authorization.substring(6)))
                        val tmp = idAndToken.split(":")
                        val uid = tmp[0]
                        val token = tmp[1]

                        val userAccessToken = accountService.verifyAccessToken(uid.toInt(), token)
                        request.session.setAttribute("loginUserAccessToken", userAccessToken)
                    } catch (e: Exception) {
                        e.printStackTrace()
                        throw ExceptionHelper.credentialException()
                    }
                }
            }
        }
        return super.preHandle(request, response, handler)
    }
}

需要配置上面的攔截器到Spring MVC中，我的是Spring Boot的配置方式

@Configuration
open class MyMvcConfig : WebMvcConfigurerAdapter() {

    /**
     * 這個(gè)方法中 @Bean 是關(guān)鍵，不然LoginInterceptor依賴的Service層無法注入
     */
    @Bean
    open fun loginInterceptor(): LoginInterceptor {
        return LoginInterceptor()
    }
    @Bean
    open fun loginUserTokenArgumentResolver(): LoginUserTokenArgumentResolver {
        return LoginUserTokenArgumentResolver()
    }
    override fun addInterceptors(registry: InterceptorRegistry) {
        // 必須調(diào)用loginInterceptor()創(chuàng)建對(duì)象，不然LoginInterceptor依賴的Service層無法注入
        registry.addInterceptor(loginInterceptor())
        super.addInterceptors(registry)
    }
    override fun addArgumentResolvers(argumentResolvers: MutableList<HandlerMethodArgumentResolver>) {
        super.addArgumentResolvers(argumentResolvers)
        argumentResolvers.add(loginUserTokenArgumentResolver())
    }
}

到了這里代碼就完成了