spring boot-自定义http状态码(@ResponseStatus、HttpServletResponse设置)

一、@ResponseStatus

@ResponseStatus有两个参数

1、value
对应枚举HttpStatus的值，此值对应相应404,403,500

2、reason
界面提示文字

@ResponseStatus(value=HttpStatus.FORBIDDEN, reason="用户名和密码不匹配!")
public class UserNameNotMatchPasswordException extends RuntimeException{
}

带有@ResponseStatus注解的异常类会被ResponseStatusExceptionResolver 解析。

注意：ResponseStatus ，只支持标准的 Http Code（必须是枚举类org.springframework.http.HttpStatus。因此某些情况下，我们需要利用HttpServletResponse返回特定http状态码。

二、HttpServletResponse

HttpServletResponse ServletResponse 返回响应 设置响应头设置响应正文体 重定向 常用方法 如何重定向 响应编码 响应乱码
参考URL: https://www.cnblogs.com/noteless/p/9428681.html

HttpServletResponse 和 ServletResponse 都是接口
具体的类型对象是由Servlet容器传递过来。

ServletResponse对象的功能分为以下四种：
 设置响应头信息；
 发送状态码；
 设置响应正文；
 重定向；

这种则是直接操作HttpServletResponse对象，手动录入返回的结果。

• 设置响应头信息

HttpServletResponse 中 (ServletResponse 中没有的)
void setHeader(String var1, String var2);

使用该方法设置的响应头最终会发送给客户端浏览器
示例:
response.setHeader(“content-type”, “text/html;charset=utf-8”);

设置content-type响应头，该头的作用是:
告诉浏览器响应内容为html类型，编码为utf-8。
而且同时会设置response的字符流编码为utf-8，即response.setCharaceterEncoding(“utf-8”)；

• 自动跳转

response.setHeader("Refresh","5; URL=http://www.baidu.com");

5秒后自动跳转到百度。

• 发送状态码以及类型

response.setContentType("text/html;charset=utf-8")；

//等同与调用response.setHeader(“content-type”, “text/html;charset=utf-8”)；
 
response.setCharacterEncoding(“utf-8”)；//设置字符响应流的字符编码为utf-8；

response.setStatus(200);//设置状态码；

response.sendError(404, “您要查找的资源不存在”);//当发送错误状态码时，Tomcat会跳转到固定的错误页面去，但可以显示错误信息。

比如:
response.sendError(404, "您要查找的资源不存在了哈");

• 设置响应正文

ServletResponse是响应对象，向客户端输出响应正文（响应体）可以使用ServletResponse的响应流
repsonse一共提供了两个响应流对象：
        PrintWriter out = response.getWriter()：获取字符流；
        ServletOutputStream out = response.getOutputStream()：获取字节流；
两个方法都是ServletResponse的 HttpServletResponse继承而得到
 
注意:
当然，如果响应正文内容为字符，那么使用response.getWriter()
如果响应内容是字节，那么可以使用response.getOutputStream()  例如下载时
在一个请求中，不能同时使用这两个流！
也就是说，要么你使用repsonse.getWriter()，要么使用response.getOutputStream()，但不能同时使用这两个流。

• 字符编码

在使用response.getWriter()时需要注意默认字符编码为ISO-8859-1，
如果希望设置字符流的字符编码为utf-8
可以使用
response.setCharaceterEncoding(“utf-8”)来设置。
这样可以保证输出给客户端的字符都是使用UTF-8编码的！
 
但客户端浏览器并不知道响应数据是什么编码的！
如果希望通知客户端使用UTF-8来解读响应数据，那么还是使用
response.setContentType("text/html;charset=utf-8")方法比较好
因为这个方法不只会调用response.setCharaceterEncoding(“utf-8”)，还会设置content-type响应头
客户端浏览器会使用content-type头来解读响应数据。

• 缓冲区

esponse.getWriter()是PrintWriter类型，所以它有缓冲区，缓冲区的默认大小为8KB。

也就是说，在响应数据没有输出8KB之前，数据都是存放在缓冲区中，而不会立刻发送到客户端。

当Servlet执行结束后，服务器才会去刷新流，使缓冲区中的数据发送到客户端。

如果希望响应数据马上发送给客户端：

   向流中写入大于8KB的数据；

   调用response.flushBuffer()方法来手动刷新缓冲区；

• 重定向
  当你访问A网址时,你会发现浏览器地址栏URL变成了B ,这就是重定向
  所谓重定向,就是服务器重新定位你的方向,告诉你去别的地方
  是再次的发出了请求,全程总共有两个请求

第一步就是设置响应码为302。
响应码为200表示响应成功，而响应码为302表示重定向,你需要告诉浏览器需要重定向
第二步设置重定向的URL
因为重定向是通知浏览器再第二个请求，所以浏览器需要知道第二个请求的URL
所以完成重定向的第二步是设置Location头，指定第二个请求的URL地址。

response.setStatus(302);
response.setHeader("Location", "https://www.cnblogs.com/noteless/");
你会发现地址栏立刻进行了跳转

重定向注意点:
 重定向是两次请求；
 重定向的URL可以是其他应用，不局限于当前应用；
 重定向的响应头为302，并且必须要有Location响应头；
 重定向就不要再使用response.getWriter()或response.getOutputStream()输出数据，不然可能会出现异常；

1. 使用举例

HttpServletResponse 返回的json数据不是json字符串，而是json对象
参考URL: https://www.cnblogs.com/dengguangxue/p/11249918.html

response.setStatus(450);
response.setCharacterEncoding("UTF-8");
response.setHeader("Content-Type", "application/json");
response.setHeader("Access-Control-Allow-Credentials", "true");
response.setHeader("Access-Control-Allow-Methods", "GET, POST");
response.setHeader("Access-Control-Allow-Origin", "*");
response.setHeader("Access-Control-Max-Age", "3600");
response.getWriter().write(JSON.toJSONString(ResponseDataUtil.buildError(
        ExceptionCodeEnum.ACCESS_NO_PERMITION.getErrorCode(),
        ExceptionCodeEnum.ACCESS_NO_PERMITION.getErrorMsg())));

1.1 在filter中使用测试

@Component
public class AuthorizationTokenFilter  extends OncePerRequestFilter {


    @Autowired
    TokenRedisService tokenRedisService;

    private String tokenHead = "";
    private String tokenHeader = "Authorization";


    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {

        // 1.从header获取token
        String token = request.getHeader(this.tokenHeader);


        // 存在
        if(StringUtils.isNotBlank(token) && SecurityContextHolder.getContext().getAuthentication() == null){
            //根据从redis中查用户、角色、权限
            UserTokenInfo userTokenInfo = tokenRedisService.getTokenFromCache(token);
            if(userTokenInfo == null){
                response.setStatus(450);
                response.setCharacterEncoding("UTF-8");
                response.setHeader("Content-Type", "application/json");
                response.setHeader("Access-Control-Allow-Credentials", "true");
                response.setHeader("Access-Control-Allow-Methods", "GET, POST");
                response.setHeader("Access-Control-Allow-Origin", "*");
                response.setHeader("Access-Control-Max-Age", "3600");
                response.getWriter().write(JSON.toJSONString(ResponseDataUtil.buildError(
                        ExceptionCodeEnum.ACCESS_NO_PERMITION.getErrorCode(),
                        ExceptionCodeEnum.ACCESS_NO_PERMITION.getErrorMsg())));

                return;
            }

            LoginUser user = userTokenInfo.getLoginUser();

            //添加授权信息
            String[] permissions = user.getPermissions();
            List<GrantedAuthority> authorities = AuthorityUtils.createAuthorityList(permissions);

            CustomUsernamePasswordAuthenticationToken authentication = new CustomUsernamePasswordAuthenticationToken(user,null, user.getCardId(), authorities);
            SecurityContextHolder.getContext().setAuthentication(authentication);
        }


        filterChain.doFilter(request, response);

    }
}

1.2 在全局异常处理类中使用测试

@RestControllerAdvice
public class DefaultGlobalExceptionHandle {
    private Logger logger = LoggerFactory.getLogger(DefaultGlobalExceptionHandle.class);

    /**
     * '
     * 定义全局异常处理，value属性可以过滤拦截条件，此处拦截所有的Exception
     *
     * @param e
     * @return
     */
    @ExceptionHandler(value = Exception.class)
    @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
    public ResponseData handle(Exception e) {
        if (e instanceof SystemErrorException) {
            //高级生产异常
            SystemErrorException systemErrorException = (SystemErrorException) e;
            logger.error("系统严重异常！ 发生异常类: [" + systemErrorException.getClass() + "], 异常信息： " + e.getCause());
            //创建异步线程，交由异常处理类处理
            //ThreadPoolUtils.getSimpleThreadPool().execute(() -> MsgUtls.push2MSG4SystemError(systemErrorException));

        } else if (e instanceof SystemWarnException) {
            SystemWarnException systemWarnException = (SystemWarnException) e;
            logger.error("系统异常！ 发生异常类: " + systemWarnException.getCause() + "], 异常信息： " + e.getCause());
        } else {
            logger.error("一般异常！  异常信息： " , e);
        }
        return ResponseDataUtil.buildError(ResultEnums.ERROR);
    }


    @ExceptionHandler(value = ServiceException.class)
    @ResponseStatus(code=HttpStatus.OK)
    @ResponseBody
    public ResponseData serviceException(ServiceException ex, HttpServletRequest request, HttpServletResponse response) {
        Integer errorCode = ex.getErrorCode();
        String msg = ex.getErrorMsg() == null ? "" : ex.getErrorMsg();
        logger.info(msg);
        return ResponseDataUtil.buildError(errorCode, msg);
    }


    @ExceptionHandler(value = ParamException.class)
    @ResponseStatus(code=HttpStatus.OK)
    @ResponseBody
    public ResponseData paramException(ParamException ex, WebRequest request) {
        Integer errorCode = ex.getErrorCode();
        String msg = ex.getErrorMsg() == null ? "" : ex.getErrorMsg();
        logger.info(msg);
        return ResponseDataUtil.buildError(errorCode, msg);
    }


    /**
     * spring security 权限校验
     * @param ex
     * @return
     */
    @ExceptionHandler(value = AccessDeniedException.class)
    @MyResponseStatus(code=MyHttpStatus.BIZ_SERVICE_EXCEPTION)
    @ResponseBody
    public void accessDeniedException(AccessDeniedException ex, HttpServletResponse response) {
        response.setStatus(450);
        response.setCharacterEncoding("UTF-8");
        response.setHeader("Content-Type", "application/json");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        response.setHeader("Access-Control-Allow-Methods", "GET, POST");
        response.setHeader("Access-Control-Allow-Origin", "*");
        response.setHeader("Access-Control-Max-Age", "3600");
        try {
            response.getWriter().write(JSON.toJSONString(ResponseDataUtil.buildError(
                    ExceptionCodeEnum.ACCESS_NO_PERMITION.getErrorCode(),
                    ExceptionCodeEnum.ACCESS_NO_PERMITION.getErrorMsg())));
        } catch (IOException e) {
            e.printStackTrace();
        }
        logger.info(ex.getMessage());
//        return ResponseDataUtil.buildError(ExceptionCodeEnum.ACCESS_NO_PERMITION);
        return ;


    }

}

经过测试，直接在参数中添加HttpServletResponse response即可。然后利用response处理即可。