springboot入门系列教程|第九篇：springboot实现图片上传与显示（附源码）

前言##

     上一篇我们介绍了springboot如何实现自定义拦截器配合注解使用，那么这篇我们将介绍springboot实现图片上传的功能。

目录##

##项目准备工作##

###环境###

jdk8
IDEA 
maven 3.3.9

项目创建###

项目目录###

---

了解概念##

###图片相对路径###
     类似于这种格式：/img/virtual
###图片绝对路径###
     类似于这种格式：C:\Users\wanghao/upload/img
###图片映射
     表示你访问图片相对路径，会自动去寻找图片的绝对路径

---

##代码##
###图片映射配置###

@Configuration
public class WebMVcConfig extends WebMvcConfigurerAdapter {
    /**
     * 配置的图片映射
     */
    private static final String imgPath = "file:" + Constant.UPLOAD_PATH + Constant.IMG_FILE_NAME +  "/";

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        //将所有访问img/virtual/**的请求映射到文件上传的路径下 C:\Users\wanghao/upload/img（图片的保存路径）
        registry.addResourceHandler("/img/virtual/**").addResourceLocations(imgPath);
        super.addResourceHandlers(registry);
    }
}

###自定义常量# ##

//常量
public class Constant {
    /** 文件上传/图片   根目录 */
    public static final String UPLOAD_PATH = System.getProperty("user.home") + "/upload/";

    /** 图片目录 */
    public static final String IMG_FILE_NAME = "img";

    /** 图片相对路径 */
    public static final String VIRTUAL_IMG_PATH = "img/virtual";
}

###文件上传工具类 ###

public class FileUtil {
    private static Logger logger = LoggerFactory.getLogger(FileUtil.class);
    /**
     * 图片存储 完整路径（{user.home}/img/coldStone/XXX.jpg）
     * @param file
     * @return 返回相对路径
     */
    public static String saveImg(MultipartFile file) {
        //获取文件上传的根目录 C:\Users\wanghao/upload/img
        String  path = Constant.UPLOAD_PATH + Constant.IMG_FILE_NAME;

        //拿到文件的后缀名和UUID进行拼接形成新的文件名
        //4ca64e85b1544c96b4a6154bb521476f.jpg
        String saveName = CommonUtil.getUuid() + "." + getFileSuffix(file.getOriginalFilename());

        logger.info(" --- 图片保存路径：{}, 图片保存名称：{} --- ", path, saveName);

        // 保存
        try {
            // 保存文件图片
            File targetFile = new File(path);
            if (!targetFile.exists()) {
                targetFile.mkdirs();
            }
            file.transferTo(new File(path + "/" + saveName));
        } catch (Exception e) {
            e.printStackTrace();
            logger.debug("--- 图片保存异常：{} ---" + e.getMessage());
            return null;
        }
        String filePath =  Constant.VIRTUAL_IMG_PATH;;
        //返回相对路径  img/virtual/4ca64e85b1544c96b4a6154bb521476f.jpg
        return filePath + "/" + saveName;
    }
    /**
     * 返回截取的文件后缀
     * @param path
     * @return
     */
    private static String getFileSuffix(String path) {
        return getFileSuffix(path, "2");
    }

    /**
     * 获取文件名称或后缀(最后一个"."之后内容)
     * @param path
     * @param type 1名称 2后缀
     * @return
     */
    private static String getFileSuffix(String path, String type){
        if(StringUtils.isNotEmpty(path) && path.indexOf(".") > 0) {
            // 名称
            String name = path.substring(0, path.lastIndexOf("."));

            // 后缀
            String suffix = path.substring(path.lastIndexOf(".") + 1);

            return StringUtils.equals("1", type) ? name : suffix;
        } else {
            return null;
        }
    }
}

###controller层###

@RestController
@RequestMapping("/coldStone")
public class ImgUploadController {

    /**
     * 图片上传
     * @param img
     * @return
     */
    @PostMapping(value = "/img/upload")
    public String uploadImg(@RequestParam("image") MultipartFile img){
        //图片上传调用工具类
        try{
            //保存图片
            String path =  FileUtil.saveImg(img);
            return path;
        }catch (Exception e){
            return "上传图片失败";
        }
    }
}

##测试##
###上传图片测试###

###访问图片测试###

##总结##
     搞清楚图片相对路径和绝对路径，以及在配置文件需要配置图片路径的映射。

---

##友情链接##

     项目地址：spring-boot-uploadImg
     上一篇：springboot实现自定义拦截器以及自定义注解
    如果有小伙伴觉得我写的不错的话可以关注一下我的博客，我会一直持续更新，也可以支持一下我的公众号哦:coldStone，主要会分享分布式系统相关的一系列技术，目前会推出springboot、springcloud和docker系列教程，后期会有关于中间件以及各个层面的性能优化的文章，同时还会分享一些赚钱理财的小套路哦，欢迎大家来支持，一起学习成长，程序员不仅仅是搬瓦工！

如果有小伙伴觉得我写的不错的话可以关注一下我的博客，我会一直持续更新，也可以支持一下我的公众号哦:java架构师小密圈，会分享架构师所必须深入研究的技术，比如netty,分布式，性能优化，spring源码分析，mybatis源码分析，等等等，同时还会分享一些赚钱理财的小套路哦，欢迎大家来支持，一起学习成长，程序员不仅仅是搬瓦工！
公众号：分享系列好文章

交流群：群友互相分享资料