top.cutexingluo.tools.utils.ee.web.front.WebUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xingtools-pkg-jdk8 Show documentation
xingtools 依赖core包，jdk 分类包，对不同的jdk版本提供兼容性
The newest version!
package top.cutexingluo.tools.utils.ee.web.front;

import org.jetbrains.annotations.NotNull;
import top.cutexingluo.tools.bridge.servlet.HttpServletResponseData;
import top.cutexingluo.tools.common.base.IResult;
import top.cutexingluo.tools.designtools.protocol.serializer.impl.json.JacksonSerializer;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.function.Consumer;

/**
 * web 返回工具类
 *
 * 推荐使用 {@link XTResponseUtil}
 */
public class WebUtils {

    public static boolean printTrace = true;
    public static Consumer exceptionHandler = null;

    /**
     * 返回请求封装
     *
     * @param rsp           返回请求
     * @param result        返回数据
     * @param rspStatusCode 返回码
     */
    public static  void response(HttpServletResponse rsp, IResult result, int rspStatusCode) throws IOException {
        JacksonSerializer serializer = new JacksonSerializer();
        String stringify = serializer.stringify(result);
//        byte[] responseBytes = new ObjectMapper().writeValueAsBytes(result);
//        new String(responseBytes)
        response(rsp, stringify, rspStatusCode);
    }

    /**
     * 返回请求
     *
     * @param rsp           返回请求
     * @param result        返回消息
     * @param rspStatusCode 返回码
     * @since 1.1.3
     */
    public static  void response(@NotNull HttpServletResponseData rsp, String result, int rspStatusCode) throws IOException {
        response(rsp.getResponse(), result, rspStatusCode);
    }


    /**
     * 返回请求
     *
     * @param rsp           返回请求
     * @param result        返回消息
     * @param rspStatusCode 返回码
     */
    public static  void response(HttpServletResponse rsp, String result, int rspStatusCode) throws IOException {
        rsp.addHeader("Content-Type", "application/json;charset=UTF-8");
        rsp.setStatus(rspStatusCode);
        rsp.getWriter().write(result);
    }

    /**
     * 将字符串渲染到客户端
     * 未来将被移除
     *
     * @param response 渲染对象
     * @param string   待渲染的字符串
     */
    @Deprecated
    public static void renderString(HttpServletResponse response, String string) {
        try {
            response.setStatus(200);
            response.setContentType("application/json");
            response.setCharacterEncoding("utf-8");
            response.getWriter().print(string);
        } catch (IOException e) {
            if (exceptionHandler != null) exceptionHandler.accept(e);
            else if (printTrace) e.printStackTrace();
        }
    }

    /**
     * 设置下载文件头
     */
    public static void setDownLoadHeader(String filename, ServletContext context, HttpServletResponse response) throws UnsupportedEncodingException {
        String mimeType = context.getMimeType(filename);//获取文件的mime类型
        response.setHeader("content-type", mimeType);
        String fname = URLEncoder.encode(filename, "UTF-8");
        response.setHeader("Content-disposition", "attachment; filename=" + fname);

//        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
//        response.setCharacterEncoding("utf-8");
    }
}