使用Okhttp实现上传文件+参数请求接口form-data

 更新时间:2024年10月23日 14:38:35   作者:JMzz  
在进行接口对接时,常遇到需要传递多种类型参数及文件上传的情况,解决此问题的关键在于参数传递和文件上传的正确处理,在Service层和Controller层的传参,可以通过@RequestParam标注或直接使用请求实体类,但若结合文件上传,则不应使用@RequestBody注解

Okhttp实现上传文件+参数请求接口form-data

有时候需要对接一些接口,而且接口传参不仅需要各种类型的参数,甚至还要上传文件,所以遇到挺多坑,用postman的生成代码也不好用,于是就有了这篇文章。

话不多说,我们直接上代码

首先是service层

    /**
     * 写注释是个好习惯
     *
     * @param mFile
     * @param accountIndex
     * @param exportType
     * @param clear
     * @param email
     * @param dimensions
     * @return
     * @throws IOException
     */
    public String upload(MultipartFile mFile, Integer accountIndex, String exportType,
                         Boolean clear, String email, String dimensions) throws IOException {
        // 这里是MultipartFile转File的过程
        File file = new File(Objects.requireNonNull(mFile.getOriginalFilename()));
        FileUtils.copyInputStreamToFile(mFile.getInputStream(), file);
        // url接口路径
        String url = "http://localhost:8080/upload";
        // file是要上传的文件 File()  这边我上传的是excel,其他类型可以自己改这个parse
        RequestBody fileBody = RequestBody.create(MediaType.parse("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"), file);//这边是把file写进来,也有写路径的,但我这边是写file文件,parse不行的话可以直接改这个"multipart/form-data"
        // 创建OkHttpClient实例,设置超时时间
        OkHttpClient okHttpClient = new OkHttpClient.Builder()
                .connectTimeout(60L, TimeUnit.SECONDS)
                .writeTimeout(60L, TimeUnit.SECONDS)
                .readTimeout(60L, TimeUnit.SECONDS)
                .build();
        // 不仅可以支持传文件,还可以在传文件的同时,传参数
        MultipartBody requestBody = new MultipartBody.Builder()
                .setType(MultipartBody.FORM) // 设置传参为form-data格式
                .addFormDataPart("account_index", String.valueOf(accountIndex))
                .addFormDataPart("export_type", exportType)
                .addFormDataPart("clear", String.valueOf(clear))
                .addFormDataPart("email", email)
                .addFormDataPart("dimensions", dimensions)
                .addFormDataPart("file", file.getName(), fileBody) // 中间参数为文件名
                .build();

        // 构建request请求体,有需要传请求头自己加
        Request request = new Request.Builder()
                .url(url)
                .post(requestBody)
                .build();
        Response response = null;
        String result = "";
        try {
            // 发送请求
            response = okHttpClient.newCall(request).execute();
            result = response.body().string();
            log.info(url + "发送请求结果:" + result);
            if (!response.isSuccessful()) {
                log.info("请求失败");
                return "请求失败";
            }
            response.body().close();
        } catch (IOException e) {
            log.error(e.getMessage());
        }
        // 会在本地产生临时文件,用完后需要删除
        if (file.exists()) {
            file.delete();
        }
        return result;
    }

然后controller层的传参需要用@RequestParam或者直接一个请求的实体类

如果使用实体类,千万不要加@RequestBody,不然结合上传文件会失效,上传文件使用

@RequestPart("file") MultipartFile file进行传参

(@RequestPart("file") MultipartFile file,
@RequestParam("accountIndex") Integer accountIndex,
@RequestParam("exportType") String exportType,
@RequestParam(value = "clear", required = false) Boolean clear,
@RequestParam("email") String email,
@RequestParam(value = "dimensions", required = false) String dimensions)

示例如上,或者

(@RequestPart("file") MultipartFile file, RequestVo req)

请求成功,问题解决。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 详解SpringBoot启动类的扫描注解的用法及冲突原则

    详解SpringBoot启动类的扫描注解的用法及冲突原则

    这篇文章主要介绍了详解SpringBoot启动类的扫描注解的用法及冲突原则,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • Spring Data JPA 关键字Exists的用法说明

    Spring Data JPA 关键字Exists的用法说明

    这篇文章主要介绍了Spring Data JPA 关键字Exists的用法说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • @RequestBody注解的原理及使用技巧分享

    @RequestBody注解的原理及使用技巧分享

    这篇文章主要介绍了@RequestBody注解的原理及使用技巧分享,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-10-10
  • SPFA 算法实例讲解

    SPFA 算法实例讲解

    下面小编就为大家带来一篇SPFA 算法实例讲解。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • Java获取上月份最后一天日期8位的示例代码

    Java获取上月份最后一天日期8位的示例代码

    这篇文章主要介绍了Java获取上月份最后一天日期8位,需要的朋友可以参考下
    2022-09-09
  • Idea中springboot项目的热部署无法生效问题解决

    Idea中springboot项目的热部署无法生效问题解决

    本文主要介绍了Idea中springboot项目的热部署无法生效问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-10-10
  • 深入剖析理解AsyncGetCallTrace源码底层原理

    深入剖析理解AsyncGetCallTrace源码底层原理

    这篇文章主要为大家介绍了AsyncGetCallTrace源码的深层原理,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2022-02-02
  • Java数据结构之AC自动机算法的实现

    Java数据结构之AC自动机算法的实现

    AC自动机算法常被认为是Trie树+KMP算法的结合体,它是一个多模式匹配算法,在模式匹配领域被广泛应用。本文将详细为大家介绍AC自动机的原理与实现方法,感兴趣的可以了解一下
    2022-12-12
  • java操作XML实例代码

    java操作XML实例代码

    这篇文章主要介绍了java操作XML实例代码,有需要的朋友可以参考一下
    2014-01-01
  • Java创建List常用几种方法

    Java创建List常用几种方法

    本文主要介绍了Java创建List常用几种方法,主要介绍了9种方法,具有一定的参考价值,感兴趣的可以了解一下
    2023-09-09

最新评论