top.jfunc.http.holderrequest.Request Maven / Gradle / Ivy

Go to download
package top.jfunc.http.holderrequest;

import top.jfunc.http.base.FormFile;
import top.jfunc.http.base.MediaType;
import top.jfunc.http.holder.*;
import top.jfunc.http.HttpRequestHttpClient;
import top.jfunc.http.SimpleHttpClient;
import top.jfunc.http.SmartHttpClient;
import top.jfunc.http.util.ParamUtil;
import top.jfunc.common.utils.MultiValueMap;
import top.jfunc.common.utils.StrUtil;

import java.io.File;
import java.net.URL;
import java.util.Map;

/**
 * 代表一个Http请求的所有参数,基于Request-Response的可以更好地扩展功能
 * @see SimpleHttpClient
 * @see HttpRequestHttpClient
 * @see SmartHttpClient
 *
 * @see HttpRequest
 * @see BaseHttpRequest
 * @see DefaultBodyRequest
 * @see StringBodyRequest
 * @see DefaultFormBodyRequest
 * @see DefaultUploadRequest
 * @see DefaultDownloadRequest
 * @author xiongshiyan at 2017/12/9
 */
public class Request extends BaseHttpRequest implements
        MutableStringBodyRequest,
        FormRequest,
        UploadRequest,
        DownloadRequest {
    /**
     * form参数
     * POST请求，会作为body存在 并且设置Content-Type为 application/xxx-form-url-encoded
     */
    private ParamHolder formParamHolder = new DefaultParamHolder();

    /**
     * 针对POST存在，params这种加进来的参数最终拼接之后保存到这里
     */
    private BodyHolder bodyHolder = new DefaultBodyHolder();

    /**
     * 2018-06-18为了文件上传增加的 private List formFiles = null;
     */
    private FormFileHolder formFileHolder = new DefaultFormFileHolder();

    /**
     * 为文件下载确定信息
     */
    private FileHolder fileHolder = new DefaultFileHolder();

    public Request(String url){super(url);}
    public Request(URL url){super(url);}
    public Request(){}

    /**
     * 静态方法创建请求
     * @param url URL
     * @return Request
     */
    public static Request of(String url){
        return new Request(url);
    }
    public static Request of(URL url){
        return new Request(url);
    }
    public static Request of(){
        return new Request();
    }

    /**
     * 如果没有显式设置body而是通过params添加的，此时一般认为是想发起form请求，最好设置Content-Type
     * @see Request#setContentType(String)
     */
    @Override
    public String getBody() {
        String body = bodyHolder().getBody();
        //如果body不为空直接返回
        if(StrUtil.isNotEmpty(body)){
            return body;
        }

        //没有设置body一般认为就是form表单传递
        ParamHolder formParamHolder = formParamHolder();
        String bodyCharset = calculateBodyCharset();
        if(null == getContentType()){
            setContentType(MediaType.APPLICATION_FORM_DATA.withCharset(bodyCharset));
        }
        return ParamUtil.contactMap(formParamHolder.get(), bodyCharset);
    }


    @Override
    public String getBodyCharset() {
        BodyHolder bodyHolder = bodyHolder();
        return StrUtil.isNotEmpty(bodyHolder.getBody()) ? bodyHolder.getBodyCharset() : formParamHolder().getParamCharset();
    }

    @Override
    public FormFileHolder formFileHolder() {
        return this.formFileHolder;
    }

    @Override
    public ParamHolder formParamHolder() {
        return this.formParamHolder;
    }

    @Override
    public FileHolder fileHolder() {
        return this.fileHolder;
    }

    @Override
    public BodyHolder bodyHolder() {
        return this.bodyHolder;
    }

    ///////////////////////////////////通过设置Holder的实现改变默认行为///////////////////////////////////////

    public Request setFormParamHolder(ParamHolder formParamHolder) {
        this.formParamHolder = formParamHolder;
        return myself();
    }

    public Request setBodyHolder(BodyHolder bodyHolder) {
        this.bodyHolder = bodyHolder;
        return myself();
    }

    public Request setFormFileHolder(FormFileHolder formFileHolder) {
        this.formFileHolder = formFileHolder;
        return myself();
    }

    public Request setFileHolder(FileHolder fileHolder) {
        this.fileHolder = fileHolder;
        return myself();
    }

    /**
     * 如果实现的多个接口中有前面完全相同的方法，那么子类中必须复写此方法，相当于解决冲突
     * 明确子类调用此方法时的行为
     * @param paramCharset 参数编码
     * @return this
     */
    @Override
    public Request setParamCharset(String paramCharset) {
        formParamHolder().setParamCharset(paramCharset);
        return myself();
    }

    @Override
    public Request setFormParams(Map params) {
        formParamHolder().set(params);
        return myself();
    }
    @Override
    public Request setFormParams(MultiValueMap params) {
        formParamHolder().set(params);
        return myself();
    }

    @Override
    public Request addFormParam(String key, String value, String... values) {
        formParamHolder().add(key, value, values);
        return myself();
    }

    @Override
    public MultiValueMap getFormParams() {
        return formParamHolder().get();
    }

    /**
     * 设置body的同时设置Content-Type
     * @see MediaType
     */
    @Override
    public Request setBody(String body , String contentType) {
        bodyHolder().setBody(body);
        setContentType(contentType);
        return myself();
    }


    ///////////// 以下方法是为了兼容以前的Request的用法[返回Request方便方法连缀] /////////////////////

    @Override
    public Request setBody(String body) {
        bodyHolder().setBody(body);
        return myself();
    }

    /**
     * 可能是form的，可能是body的，最终其实都是body，
     * 如果想单独设置，请使用分别的holder引用来设置
     * @param bodyCharset bodyCharset
     * @return this
     */
    @Override
    public Request setBodyCharset(String bodyCharset) {
        bodyHolder().setBodyCharset(bodyCharset);
        formParamHolder().setParamCharset(bodyCharset);
        return myself();
    }

    @Override
    public Request addFormFile(FormFile... formFiles) {
        formFileHolder().addFormFile(formFiles);
        return myself();
    }

    @Override
    public Request addFormFiles(Iterable formFiles) {
        formFileHolder().addFormFiles(formFiles);
        return myself();
    }

    @Override
    public Request setFile(File file) {
        fileHolder().setFile(file);
        return myself();
    }

    /////////////////////////////////// END /////////////////////////////////////
}