快捷導(dǎo)航

詳解SpringBoot如何優(yōu)雅的處理免登錄接口

更新時(shí)間：2024年01月02日 09:32:12 作者：RoronoaV587

在項(xiàng)目開發(fā)過程中,會(huì)有很多API接口不需要登錄就能直接訪問,比如公開數(shù)據(jù)查詢之類的,常規(guī)處理方法基本是使用攔截器或過濾器,攔截需要認(rèn)證的請(qǐng)求路徑,本文介紹一個(gè)更優(yōu)雅的方法自定義注解的方式,文中通過代碼示例介紹的非常詳細(xì),需要的朋友可以參考下

在項(xiàng)目開發(fā)過程中，會(huì)有很多API接口不需要登錄就能直接訪問，比如公開數(shù)據(jù)查詢之類的 ~

常規(guī)處理方法基本是使用攔截器或過濾器，攔截需要認(rèn)證的請(qǐng)求路徑。在攔截器中判斷session或token信息，如果存在則放行，否則跳轉(zhuǎn)到登錄頁。過濾器原理與攔截器類似，可以在過濾器中判斷請(qǐng)求的session或token信息，麻煩的地方就是：每次開發(fā)新的免登錄接口的時(shí)候，都需要去配置一下路徑

今天介紹一個(gè)更優(yōu)雅的方法：自定義注解的方式

基本思路是：自定義一個(gè)注解，在不需要校驗(yàn)登錄的Controller方法或類上使用該注解。通過AOP或攔截器在方法執(zhí)行前判斷免登錄狀態(tài)

自定義注解這里命名為NoToken

import java.lang.annotation.*;
 
/**
 * 不校驗(yàn)token注解
 */
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NoToken {
    String name() default "";
}

這里采用攔截器搭配使用，攔截器代碼如下

@Slf4j
public class SessionInterceptor implements HandlerInterceptor {
 
    //在請(qǐng)求處理之前進(jìn)行調(diào)用Controller方法調(diào)用之前
    @Override
    @Reference
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
 
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            NoToken classAnno = handlerMethod.getMethod().getDeclaringClass().getAnnotation(NoToken.class);
            //獲取出Controller上的NoToken注解
            if (classAnno != null) {
                // 如果注解不為null, 說明不需要攔截, 直接放過
                return true;
            } else {
                Method method = handlerMethod.getMethod();
                handlerMethod.getMethodAnnotation(NoToken.class);
                //獲取出方法上的NoToken注解
                NoToken access = method.getAnnotation(NoToken.class);
                if (access != null) {
                    // 如果注解不為null, 說明不需要攔截, 直接放過
                    return true;
                }
            }
        }
 
        RedisService redis = (RedisService) SpringContextUtils.getBean("redisService");
        String token = request.getHeader("token");
 
 
        boolean ok = false;
        log.info("開始檢驗(yàn)token!");
        if (!StringUtils.isEmpty(token)) {
            if (redis.exists(token)) {
                redis.expire(token, ConstantsUtil.APP_TOKEN_EXPIRE);
                log.info("token有效!");
                ok = true;
            }
        }
 
 
        if (!ok) {
            Map<String, Object> result = new HashMap<>();
            result.put("returncode","-1");
            result.put("returnmsg", "登錄已過期,請(qǐng)重新登錄");
            writeJSON(response, result);
            return ok;
        }
        return ok;
 
    }
 
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception e) throws Exception {
 
    }
    public void writeJSON(HttpServletResponse response, Object o)
            throws IOException {
        response.setContentType("text/html;charset=UTF-8");
        PrintWriter out = response.getWriter();
        String JsonString = JSON.toJSONString(o);
        out.write(JsonString);
    }
}

大家看到在NoToken注解和攔截器上，做了兩種處理也就是類注解 和 方法注解

如果注解放到方法上，該方法調(diào)用的時(shí)候就是免登錄的。如果注解放到@Controller類上，那么該類下的所有請(qǐng)求接口，都是免登錄的（是不是很方便 ~）

/**
 * 類上加NoToken注解，該類下所有方法都免登錄
 */
@NoToken
@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
 
 
    /**
     * 方法上單獨(dú)加注解，只對(duì)該方法免登錄
     */
    @NoToken
    @RequestMapping("testMethod")
    public void testMethod() {
        System.out.println("1111111111111");
    }
 
 
}

以上就是實(shí)現(xiàn)方式，如果覺得還有用，就點(diǎn)個(gè)贊吧 ~

到此這篇關(guān)于詳解SpringBoot如何優(yōu)雅的處理免登錄接口的文章就介紹到這了,更多相關(guān)SpringBoot處理免登錄接口內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: