Spring Boot實(shí)現(xiàn)功能的統(tǒng)一詳解

更新時(shí)間：2022年06月20日 09:12:30 作者：獨(dú)一無二的哈密瓜

這篇文章主要介紹了Spring Boot統(tǒng)一功能的處理，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

1. 統(tǒng)一用戶登錄權(quán)限驗(yàn)證

攔截器的實(shí)現(xiàn)分為兩步:

創(chuàng)建自定義攔截器, 實(shí)現(xiàn) HandlerInterceptor 接口并重寫 preHandle 方法

配置攔截器和攔截規(guī)則, (將自定義攔截器加入 WebMvcConfigurer 的 addInterceptors 方法中)

1.1 自定義攔截器

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        HttpSession session = request.getSession(false);
        if (session != null && session.getAttribute("user") != null) {
            return true;
        }
        response.setStatus(401);
        return false;
    }
}

1.2 將自定義攔截器加入到系統(tǒng)配置

@Configuration
public class AppConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**") // 攔截所有的接口
                .excludePathPatterns("/**/login.html"); // 排除的接口
    }
}

addPathPatterns : 表示要攔截的URL.

excludePathPatterns : 表示需要排除的URL

1.3 運(yùn)行結(jié)果

1.4 總結(jié)

Spring 中的攔截器是通過動(dòng)態(tài)代理和環(huán)繞通知的思想實(shí)現(xiàn)的.

2. 統(tǒng)一異常處理

統(tǒng)一異常處理使用的是 @ControllerAdvice + @ExceptionHandler 來實(shí)現(xiàn)的,

@ControllerAdvice 表示控制器通知類
@ExceptionHandler 是異常處理器

兩個(gè)結(jié)合表示當(dāng)出現(xiàn)異常的時(shí)候執(zhí)行某個(gè)通知, 也就是執(zhí)行某個(gè)方法事件

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

@ControllerAdvice
@ResponseBody
public class ErrorAdvice {
    @ExceptionHandler(NullPointerException.class)
    public Object nullPointerException(NullPointerException e) {
        HashMap<String, Object> map = new HashMap<>();
        map.put("success",200);
        map.put("status",-1);
        map.put("message","空指針異常!");
        return map;
    }
}

2.2 運(yùn)行結(jié)果

@RestController
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/hi")
    public String say() {
        Object object = null;
        int i = object.hashCode();
        return "Hello";
    }
}

3. 統(tǒng)一數(shù)據(jù)返回格式

統(tǒng)一的數(shù)據(jù)返回格式可以使用 @ControllerAdvice + ResponseBodyAdvice 的方式實(shí)現(xiàn).

添加@ControllerAdvice
實(shí)現(xiàn)ResponseBodyAdvice接口, 并重寫beforeBodyWrite方法

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

@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {
    /**
     * 內(nèi)容是否重寫, 返回true表示重寫
     */
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        // 統(tǒng)一數(shù)據(jù)格式的封裝
        HashMap<String, Object> result = new HashMap<>();
        result.put("success",200);
        result.put("status",1);
        result.put("data",body);
        return result;
    }
}

3.2 運(yùn)行結(jié)果

@RestController
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/index")
    public Object index() {
        User user = new User();
        user.setUsername("SpringAOP");
        user.setPassword("123456");
        return user;
    }
}