基于SpringBoot的图片上传与显示(附源码)

心已赠人 2022-05-23 02:12 246阅读 0赞

### Demo地址 ###

[https://github.com/HelloSummer5/FileUploadDemo][https_github.com_HelloSummer5_FileUploadDemo]

### 效果图预览 ###

![图片上传Demo预览图][Demo]

### 思路 ###

*  一般情况下都是将用户上传的图片放到服务器的某个文件夹中，然后将图片在服务器中的路径存入数据库。本Demo也是这样做的。
 *  由于用户自己保存的图片文件名可能跟其他用户同名造成冲突，因此本Demo选择了使用UUID来生成随机的文件名解决冲突。
 *  但是本Demo不涉及任何有关数据库的操作，便于演示，就用原来的文件名。

### 步骤 ###

#### pom相关依赖 ####

*  基于Spring boot当然是继承了spring boot这不用多说
 *  具体依赖，主要是FreeMarker相关依赖为了展现页面，习惯用JSP也可以添加JSP的依赖，只是为了展示页面，这个不重要。

<dependencies>
     
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-freemarker</artifactId>
           </dependency>
    
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-web</artifactId>
           </dependency>
    
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-test</artifactId>
               <scope>test</scope>
           </dependency>
       </dependencies>

#### application.properties相关配置 ####

*  除了视图模板相关的配置，**重点是要配置一下文件上传的内存大小和文件上传路径**

server.port=8102
    
    ### FreeMarker 配置
    spring.freemarker.allow-request-override=false
    #Enable template caching.启用模板缓存。
    spring.freemarker.cache=false
    spring.freemarker.check-template-location=true
    spring.freemarker.charset=UTF-8
    spring.freemarker.content-type=text/html
    spring.freemarker.expose-request-attributes=false
    spring.freemarker.expose-session-attributes=false
    spring.freemarker.expose-spring-macro-helpers=false
    #设置面板后缀
    spring.freemarker.suffix=.ftl
    
    # 设置单个文件最大内存
    multipart.maxFileSize=50Mb
    # 设置所有文件最大内存
    multipart.maxRequestSize=50Mb
    # 自定义文件上传路径
    web.upload-path=E:/Develop/Files/Photos/

#### 生成文件名 ####

*  不准备生成文件名的可以略过此步骤

package com.wu.demo.fileupload.demo.util;
    
    public class FileNameUtils {
    
        /**
         * 获取文件后缀
         * @param fileName
         * @return
         */
        public static String getSuffix(String fileName){
            return fileName.substring(fileName.lastIndexOf("."));
        }
    
        /**
         * 生成新的文件名
         * @param fileOriginName 源文件名
         * @return
         */
        public static String getFileName(String fileOriginName){
            return UUIDUtils.getUUID() + FileNameUtils.getSuffix(fileOriginName);
        }
    
    }

import java.util.UUID;
    
    /**
     * 生成文件名
     */
    public class UUIDUtils {
    
        public static String getUUID(){
            return UUID.randomUUID().toString().replace("-", "");
        }
    
    }

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

package com.wu.demo.fileupload.demo.util;
    
    import org.springframework.web.multipart.MultipartFile;
    
    import java.io.File;
    import java.io.IOException;
    
    /**
     * 文件上传工具包
     */
    public class FileUtils {
    
        /**
         *
         * @param file 文件
         * @param path 文件存放路径
         * @param fileName 源文件名
         * @return
         */
        public static boolean upload(MultipartFile file, String path, String fileName){
        
            // 生成新的文件名
            //String realPath = path + "/" + FileNameUtils.getFileName(fileName);
    
            //使用原文件名
            String realPath = path + "/" + fileName;
    
            File dest = new File(realPath);
    
            //判断文件父目录是否存在
            if(!dest.getParentFile().exists()){
                dest.getParentFile().mkdir();
            }
    
            try {
                //保存文件
                file.transferTo(dest);
                return true;
            } catch (IllegalStateException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
                return false;
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
                return false;
            }
    
        }
    }

#### Controller ####

package com.wu.demo.fileupload.demo.controller;
    
    import com.wu.demo.fileupload.demo.util.FileUtils;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.core.io.ResourceLoader;
    import org.springframework.http.ResponseEntity;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.multipart.MultipartFile;
    
    import javax.servlet.http.HttpServletResponse;
    import java.util.Map;
    
    @Controller
    public class TestController {
    
        private final ResourceLoader resourceLoader;
    
        @Autowired
        public TestController(ResourceLoader resourceLoader) {
            this.resourceLoader = resourceLoader;
        }
    
        @Value("${web.upload-path}")
        private String path;
    
        /**
         * 跳转到文件上传页面
         * @return
         */
        @RequestMapping("test")
        public String toUpload(){
            return "test";
        }
    
        /**
         *
         * @param file 要上传的文件
         * @return
         */
        @RequestMapping("fileUpload")
        public String upload(@RequestParam("fileName") MultipartFile file, Map<String, Object> map){
    
            // 要上传的目标文件存放路径
            String localPath = "E:/Develop/Files/Photos";
            // 上传成功或者失败的提示
            String msg = "";
    
            if (FileUtils.upload(file, localPath, file.getOriginalFilename())){
                // 上传成功，给出页面提示
                msg = "上传成功！";
            }else {
                msg = "上传失败！";
    
            }
    
            // 显示图片
            map.put("msg", msg);
            map.put("fileName", file.getOriginalFilename());
    
            return "forward:/test";
        }
    
        /**
         * 显示单张图片
         * @return
         */
        @RequestMapping("show")
        public ResponseEntity showPhotos(String fileName){
    
            try {
                // 由于是读取本机的文件，file是一定要加上的， path是在application配置文件中的路径
                return ResponseEntity.ok(resourceLoader.getResource("file:" + path + fileName));
            } catch (Exception e) {
                return ResponseEntity.notFound().build();
            }
        }
    
    }

#### 页面 ####

*  页面主要是**from表单**和下面的 `<img src="/show?fileName=${fileName}" />`，其余都是细节。

<!DOCTYPE html>
    <head>
        <meta charset="UTF-8" />
        <title>图片上传Demo</title>
    </head>
    <body>
    <h1 >图片上传Demo</h1>
    <form action="fileUpload" method="post" enctype="multipart/form-data">
        <p>选择文件: <input type="file" name="fileName"/></p>
        <p><input type="submit" value="提交"/></p>
    </form>
    <#--判断是否上传文件-->
    <#if msg??>
        <span>${msg}</span><br>
    <#else >
        <span>${msg!("文件未上传")}</span><br>
    </#if>
    <#--显示图片，一定要在img中的src发请求给controller，否则直接跳转是乱码-->
    <#if fileName??>
    <img src="/show?fileName=${fileName}" style="width: 200px"/>
    <#else>
    <img src="/show" style="width: 100px"/>
    </#if>
    </body>
    </html>

[https_github.com_HelloSummer5_FileUploadDemo]: https://github.com/HelloSummer5/FileUploadDemo
[Demo]: /images/20220523/f87b9352f69b440ab54ad891e00db767.png