SpringBoot接口中如何直接返回图片数据

目录

• 接口直接返回图片数据
• 起因
• 类似这种
• 根据个人经验
• 优雅的实现图片返回

接口直接返回图片数据

起因

最近在做涉及到分享推广的业务，需要由业务员分享二维码进入推广页面，由于是新项目，前期预算和用量都有限，没有搭建对象存储服务，所以决定使用后台服务动态生成二维码图片直接图片数据并返回。

首先是二维码的生成，决定使用google的zxing，毕竟google的东西还是不错的，maven添加依赖如下：

<!-- https://mvnrepository.com/artifact/com.google.zxing/core -->
        <dependency>
            <groupId>com.google.zxing</groupId>
            <artifactId>core</artifactId>
            <version>3.3.3</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.google.zxing/javase -->
        <dependency>
            <groupId>com.google.zxing</groupId>
            <artifactId>javase</artifactId>
            <version>3.3.3</version>
        </dependency>

继续查zxing的使用方法，发现大多数都是生成二维码然后写成图片文件的，不太适合我现在的情况。

类似这种

Map hints = new HashMap();
hints.put(EncodeHintType.CHARACTER_SET, "utf-8");
hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.M);
hints.put(EncodeHintType.MARGIN, 2);
BitMatrix qrcode = new QRCodeWriter().encode(href, BarcodeFormat.QR_CODE, 300, 300);
//网上的方案大多数都是通过io流写到文件系统，
MatrixToImageWriter.writeToStream(qrcode,"png",response.getOutputStream());

于是企图用response的输出流返回，但是返回的数据浏览器看到的全是乱码，这种方案并没有成功

根据个人经验

一般这种开源方案既然二维码数据BitMatrix对象都生成了，肯定有获取原始数据的方法，点进MatrixToImageWriter类搜索方法，果然，找到了能直接返回BufferedImage对象的方法

现在，BufferedImage对象已经有了，只差把它扔回前端了，继续百度，发现可以直接返回该对象，类似以下配置

@GetMapping(value = "/qrcode", produces = MediaType.IMAGE_JPEG_VALUE)
@ResponseBody
public BufferedImage generateQRCode() {
        //返回BufferedImage的对象
    }

以为问题即将解决，然而浏览器访问返回406，上网一查，原来是没有对应消息类型的转换器导致的，有博主提到需要如下配置

@Bean
    public BufferedImageHttpMessageConverter addConverter(){
        return new BufferedImageHttpMessageConverter();
    }

加了上面的配置后发现问题仍没有解决，报错仍是406，怀疑配置没有生效，于是决定走源码查看原因。debug源码时发现messageConverters的list中确实没有我配置的，说明的确是配置问题，查找messageConverters的set操作，查到如图的地方

发现springMVC是在配置RequestMappingHandlerAdapter设置的HttpMessageConverter，进入getMessageConverters()方法

根据我的工地英语8级，extendMessageConverters这个方法应该是在添加自定义的HttpMessageConverter，进入该方法

空实现，很明显估计是模板模式，需要自己去扩展，于是自己写了一个配置类继承WebMvcConfigurationSupport,重写extendMessageConverters方法

    @Override
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(new BufferedImageHttpMessageConverter());
    }

浏览器再访问，二维码图片展示，问题解决

总结：实现一个方案的过程中碰到了各种各样的奇怪问题，最好的方式是先网上找资料快速解决问题，如果无法解决，再通过自己走源码的方式从根本原因上寻找出现问题的原因，解决问题最复杂的地方是定位问题，问题定位了，解决便不再是难题

优雅的实现图片返回

注意：response.setContentType("image/png");这行代码一定要加上

@RestController
@Slf4j
@Api(tags = SwaggerConfig.TAG_IMAGE)
@RequestMapping(SwaggerConfig.TAG_IMAGE)
public class ImageController {
    @Resource
    private HttpServletResponse response;
    @GetMapping(value = "/getImage")
    @ApiOperation("获取图片-以ImageIO流形式写回")
    public void getImage() throws IOException {
        OutputStream os = null;
        try {
//        读取图片
            BufferedImage image = ImageIO.read(new FileInputStream(new File("F:\\谷歌下载\\未命名文件.png")));
            response.setContentType("image/png");
            os = response.getOutputStream();
            if (image != null) {
                ImageIO.write(image, "png", os);
            }
        } catch (IOException e) {
            log.error("获取图片异常{}",e.getMessage());
        } finally {
            if (os != null) {
                os.flush();
                os.close();
            }
        }
    }
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。