springboot 實戰:異常與重定向問題

Posted on by

springboot 異常與重定向

在spring中，有兩個重定向類型：

  • 301，永久性跳轉
  • 302，暫時性跳轉

默認調用302。

1.下面先通過一個簡單的例子實現頁面的重定向

@RequestMapping("/redirect/[code]")
    public RedirectView redirectView(@PathVariable("code") int code,
                               HttpSession session){
 
        RedirectView red = new RedirectView("/",true);
            //判斷是不是301異常
            if (code == 301){
                //默認為302轉移，此處設置為永久性轉移
                red.setStatusCode(HttpStatus.MOVED_PERMANENTLY);
            }
            return red;
    }

結果：

無論是訪問“redirect/301”還是“redirect/302”，結果都會跳轉到首頁，隻是一個是301類型，一個是302類型。

2.通過一個更簡單的方法實現重定向

    @RequestMapping("/redirect/[code]")
    public RedirectView redirectView(@PathVariable("code") int code,
                               HttpSession session){
 
        //這種跳轉都是302跳轉，通過一個redirect前綴告訴請求，要跳轉到首頁
        //所有的redirect請求都會跳轉到首頁
        return "redirect:/";
    }

結果：

這種方式重定向，都是通過302的方式進行的，無論“redirect”後面的url是什麼，因為隻要識別到redirect這個前綴，就會跳轉到首頁。

3.在重定向過程中，用session傳遞信息

1.重定向頁面
    @RequestMapping("/redirect/[code]")
    public String redirectView(@PathVariable("code") int code,
                               HttpSession session){
 
        //這種跳轉都是302跳轉，通過一個redirect前綴告訴請求，要跳轉到首頁
        //所有的redirect請求都會跳轉到首頁
        //通過session來傳遞信息
        session.setAttribute("msg","Jump from redirect");
        return "redirect:/";
    }
2.首頁
    @RequestMapping("/")
    @ResponseBody
    public String index(HttpSession session){
        //在首頁中顯示重定向中的session
        return "Hello World!" + session.getAttribute("msg");
    }

結果：

無論redirect後面的url是什麼，都會返回首頁，並顯示相應的信息。

4.admin請求異常

    @RequestMapping("/admin")
    @ResponseBody
    public String admin(@RequestParam("key") String key){
    //如果key=“admin”
        if ("admin".equals(key)){
            return "hello admin";
        }
    //否則拋出異常
        throw new IllegalArgumentException("Key Wrong!");
    }

結果：

在“key=admin”的時候，返回相應信息；在“key！=admin”的時候，返回錯誤信息。

5.自己定義異常

   @ExceptionHandler()
    @ResponseBody
    public String error(Exception e){
        return "error:" + e.getMessage();
    }

結果：

可以看出，在出現異常的時候，使我們自己定義的異常界面內容，和4中的不同。

springboot 異常統一處理

這裡先對需要使用到的註解或者類進行說明，順便理清楚條理。

@ExceptionHandler：註解使用在方法上，值為指定某個異常，當該方法所在的controller出現的異常與註解的異常對應，則會觸發註解的方法。

下面這個controller一旦出現異常都會將異常捕獲轉給該方法進行處理

@RestController
@RequestMapping("user")
public class UserController {
    @ExceptionHandler(value = Exception.class)
    public void solveException(){
        //異常處理邏輯
    }
    
}

@controllerAdvice： 註解在類上，註解的類會註冊到spring容器中，類中可有三種註解，@ExceptionHandler，@InitBinder，@ModelAttribute。該類下隻要是註解上面三個註解的方法就是讓把方法應用到程序中所有帶有@RequesMapping註解的方法上。

流程 ：

  • 自定義一個自己的異常
  • 聲明帶有@ControllerAdvice的類和@ExceptionHandler的方法，將@ExceptionHandler的方法應用到所有controller。
  • 聲明一個返回結果類
  • 聲明一個枚舉類，用來包含可能出現的異常類型

Demo

自定義異常：

@Data
@AllArgsConstructor
public class MyException extends RuntimeException{
    private Integer code;
    private String msg;
    public MyException(ResultEnum resultEnum){
        this.msg = resultEnum.getMsg();
        this.code = resultEnum.getCode();
    }
}

自定義返回結果：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Result {
    private int code;
    private String msg;
}

枚舉類：

public enum  ResultEnum {
    UNKNOW_ERROR(-1,"未知錯誤"),
    USER_ERROR(-2,"用戶信息錯誤"),
    SUCCESS(0,"成功");
    private  Integer code;
    private  String msg;
    ResultEnum(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    //省略getter和setter
}

工具類：

public class ResultUtil {
    public static Result error(Integer code, String msg) {
        Result result = new Result();
        result.setCode(code);
        result.setMsg(msg);
        return result;
    }
}

自定義異常捕獲類：

@ControllerAdvice
@Slf4j
public class MyExceptionHandler {
 //接收的是Exception，也就是隻要是異常都會執行這方法
    @ExceptionHandler(value=Exception.class)
    @ResponseBody
    public Result handle(Exception e){
        if(e instanceof MyException){
            MyException myException = (MyException) e;
            return ResultUtil.error(myException.getCode(),myException.getMsg());
        }else{
            return ResultUtil.error(-1,"未知錯誤");
        }
    }
}

controller類：

@RestController
@RequestMapping("user")
public class UserController {
    @GetMapping("exception")
    public void catchException() throws Exception{
        throw new MyException(ResultEnum.USER_ERROR);
    }
 }

流程：

  • 我們訪問http://localhost:8080/user/exception來訪問該方法，並拋出我們自定義的異常，通過枚舉類來進行對異常信息的集合。
  • 通過自定義的異常捕獲類，來進行對異常的捕獲，執行方法。
  • 異常捕獲類的方法中，通過ResultUtil工具類來進行生成Result對象返回。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：