1、添加鲁班前端上传图片，视频，作品封面图对应的后端服务

徐烜
1 parent 22cc603d
Showing 9 changed files with 513 additions and 15 deletions
src/main/java/com/bsth/luban_springboot2/controller/UploadController.java
src/main/java/com/bsth/luban_springboot2/dto/UploadFileDto.java
src/main/java/com/bsth/luban_springboot2/dto/request/UploadFileQueryRequest.java
src/main/java/com/bsth/luban_springboot2/entity/UploadFile.java
src/main/java/com/bsth/luban_springboot2/repo/UploadFileRepo.java
src/main/java/com/bsth/luban_springboot2/service/UploadFileService.java
src/main/java/com/bsth/luban_springboot2/service/impl/UploadFileServiceImpl.java
src/main/resources/application-db.properties
src/main/resources/application.properties
 package com.bsth.luban_springboot2.controller;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RestController;
+import com.bsth.luban_springboot2.dto.UploadFileDto;
+import com.bsth.luban_springboot2.dto.request.UploadFileQueryRequest;
+import com.bsth.luban_springboot2.service.UploadFileService;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.domain.PageRequest;
+import org.springframework.data.domain.Sort;
+import org.springframework.http.CacheControl;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.WebDataBinder;
+import org.springframework.web.bind.annotation.*;
+import org.springframework.web.context.request.WebRequest;
 import org.springframework.web.multipart.MultipartFile;
+import javax.validation.Valid;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+
 /**
  * 上传文件控制器
  * TODO：swagger标注后面再加
@@ -13,14 +27,80 @@ import org.springframework.web.multipart.MultipartFile;
 @RestController
 @RequestMapping(value = "/upload")
 public class UploadController {
+    @Autowired
+    private UploadFileService uploadFileService;
+
+    @InitBinder
+    protected void initBinder(WebDataBinder binder) {
+        // springMVC请求参数绑定对象属性时，忽略前缀是下划线的名字，如_ocx这种参数
+        // 1、不使用下划线
+        // 2、使用initBinder定义没有前缀
+        binder.setFieldMarkerPrefix(null);
+    }
+    // 上传文件
     @PostMapping
-    public void upload(
+    public List<UploadFileDto> upload(
             @RequestParam(name = "files") MultipartFile file,
-            @RequestParam(name = "workId") Long workId) {
-        // TODO：后面再做上传
+            @RequestParam(name = "workId", required = false) Long workId) {
+        List<UploadFileDto> rst = new ArrayList<>();
+        rst.add(this.uploadFileService.upload(file, workId));
+        return rst;
+    }
+
+    // 获取文件
+    @GetMapping(value = "/getFile/{hash}")
+    public ResponseEntity<byte[]> getUploadFile(@PathVariable("hash") String hash, WebRequest webRequest) {
+        if (webRequest.checkNotModified(hash)) { // 使用请求头If-None-Match 比较etag，一致说明未改变，返回null 304
+            return null;
+        }
+
+        UploadFileDto uploadFileDto = this.uploadFileService.getUploadFile(hash);
+        // 设置http头
+        HttpHeaders httpHeaders = new HttpHeaders();
+        httpHeaders.setCacheControl(CacheControl.maxAge(60L, TimeUnit.SECONDS)); // 设置 cache-control
+        httpHeaders.setContentType(new MediaType(uploadFileDto.getMimeType(), uploadFileDto.getMimeSubType())); // 设置 mime
+        return ResponseEntity
+                .ok() // 注意：如果使用HttpStatus.CREATED，ie下会有问题，HttpStatus.Ok表示服务端已经创建了文件，不是下载文件
+                .headers(httpHeaders)
+                .eTag(uploadFileDto.getHash()) // 设置 etag
+                .body(uploadFileDto.getBytes());
+
+    }
+
+    class UploadFilesCount {
+        private Long count;
+
+        public Long getCount() {
+            return count;
+        }
+
+        public void setCount(Long count) {
+            this.count = count;
+        }
+    }
+    // 文件数量
+    @RequestMapping(value = "/files/count", method = RequestMethod.GET)
+    public UploadFilesCount countFiles() {
+        UploadFileDto uploadFileDto = UploadFileDto.builder()
+                .cover(Boolean.FALSE)
+                .build();
+        Long count = this.uploadFileService.count(uploadFileDto);
+        UploadFilesCount uploadFilesCount = new UploadFilesCount();
+        uploadFilesCount.setCount(count);
+        return uploadFilesCount;
+    }
+    @RequestMapping(value = "/files", method = RequestMethod.GET)
+    public List<UploadFileDto> listFiles(@Valid @ModelAttribute UploadFileQueryRequest request) {
+        PageRequest pageRequest = PageRequest.of(
+                request.get_start(), request.get_limit(),
+                Sort.Direction.DESC, "createTime");
+        UploadFileDto uploadFileDto = UploadFileDto.builder()
+                .cover(Boolean.FALSE)
+                .mime(request.getMime())
+                .build();
+        return this.uploadFileService.listFiles(uploadFileDto, pageRequest);
-        System.out.println(workId);
     }
 }
+package com.bsth.luban_springboot2.dto;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Builder;
+import lombok.Data;
+
+import java.io.Serializable;
+import java.util.Date;
+import java.util.List;
+
+/**
+ * 上传文件dto。
+ */
+@Data
+@Builder
+public class UploadFileDto implements Serializable {
+    private static final long serialVersionUID = 5081335904680172897L;
+
+    /** Id */
+    private Long id;
+    /** 文件名 */
+    private String name;
+    /** 文件大小 */
+    private String size;
+    /** 文件名hash值 */
+    private String hash;
+    /** 文件后缀名 */
+    private String ext;
+    /** 文件mime类型 */
+    private String mime;
+    /** 获取文件url */
+    private String url;
+    /** 创建时间 */
+    @JsonProperty(value = "created_at")
+    private Date createTime;
+    /** 更新时间 */
+    @JsonProperty(value = "updated_at")
+    private Date updateTime;
+
+    /** 以下属性鲁班h5前端可能需要 */
+    private String provider;
+    @JsonProperty(value = "provider_metadata")
+    private String providerMetadata;
+    private List related;
+    private String sha256;
+
+    /** 字节 */
+    @JsonIgnore
+    private byte[] bytes;
+    /** mime主类型 如：image */
+    @JsonIgnore
+    private String mimeType;
+    /** mime子类型 如：png */
+    @JsonIgnore
+    private String mimeSubType;
+    /** 是否是作品封面 */
+    @JsonIgnore
+    private Boolean cover;
+
+
+}
+package com.bsth.luban_springboot2.dto.request;
+
+import lombok.Data;
+
+/**
+ * 上传文件查询请求request。
+ */
+@Data
+public class UploadFileQueryRequest {
+    /** 每页记录数 */
+    private Integer _limit;
+    /** 第几页（从0开始） */
+    private Integer _start;
+    /** mime类型 */
+    private String mime;
+}
+package com.bsth.luban_springboot2.entity;
+
+import lombok.Data;
+
+import javax.persistence.*;
+import java.io.Serializable;
+import java.util.Date;
+
+/**
+ * 上传文件描述entity。
+ * 手动sql：
+ * DROP TABLE IF EXISTS `upload_file`;
+ * CREATE TABLE `upload_file` (
+ *  `id` int(11) NOT NULL AUTO_INCREMENT,
+ *  `name` varchar(255) NOT NULL,
+ *  `hash` varchar(255) NOT NULL,
+ *  `sha256` varchar(255) DEFAULT NULL,
+ *  `ext` varchar(255) DEFAULT NULL,
+ *  `mime` varchar(255) NOT NULL,
+ *  `size` varchar(255) NOT NULL,
+ *  `url` varchar(255) NOT NULL,
+ *  `provider` varchar(255) NOT NULL,
+ *  `provider_metadata` longtext,
+ *  `created_at` timestamp NULL DEFAULT CURRENT_TIMESTAMP,
+ *  `updated_at` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+ *  PRIMARY KEY (`id`),
+ *  FULLTEXT KEY `SEARCH_UPLOAD_FILE` (`name`,`hash`,`sha256`,`ext`,`mime`,`size`,`url`,`provider`)
+ * ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+ *
+ */
+@Data
+@Entity
+@Table(name = "upload_file")
+public class UploadFile implements Serializable {
+    private static final long serialVersionUID = 8914367416120468153L;
+
+    /** Id */
+    @Id
+    @GeneratedValue(strategy = GenerationType.AUTO)
+    @Column(length = 11)
+    private Long id;
+
+    /** 上传的文件名（如：test.png）*/
+    @Column(nullable = false)
+    private String name;
+
+    /** 上传的文件名 hash（使用uuid编码）*/
+    @Column(nullable = false)
+    private String hash;
+
+    /** TODO：文件编码 */
+    private String sha256;
+
+    /** 文件后缀名（如：.png）*/
+    private String ext;
+
+    /** 文件mime类型（如：image/png）*/
+    @Column(nullable = false)
+    private String mime;
+
+    /** 文件大小，单位k（如：24.5）*/
+    @Column(nullable = false)
+    private String size;
+
+    /** 获取文件url（如：/upload/124455.png）*/
+    @Column(nullable = false)
+    private String url;
+
+    /** TODO：默认写local，strapi中使用的 */
+    @Column(nullable = false)
+    private String provider = "local";
+    /** TODO：和provier配对，strapi中使用的 */
+    @Lob
+    private String providerMetadata;
+
+    /** 自定义的新字段 */
+    @Lob
+    @Column(nullable = false)
+    private String realPath; // 后端保存的真实路径
+
+    @Column(nullable = false)
+    private Boolean cover = Boolean.FALSE; // 是否是作品封面图
+
+    /** 创建时间 */
+    @Temporal(TemporalType.TIMESTAMP)
+    @Column(nullable = false)
+    private Date createTime = new Date();
+
+    /** 更新时间 */
+    @Temporal(TemporalType.TIMESTAMP)
+    @Column(nullable = false)
+    private Date updateTime = new Date();
+}
+package com.bsth.luban_springboot2.repo;
+
+import com.bsth.luban_springboot2.entity.UploadFile;
+import org.springframework.stereotype.Repository;
+
+/**
+ * 上传文件Repo。
+ */
+@Repository
+public interface UploadFileRepo extends BaseRepository<UploadFile, Long> {
+
+    UploadFile findByHash(String hash);
+}
+package com.bsth.luban_springboot2.service;
+
+import com.bsth.luban_springboot2.dto.UploadFileDto;
+import org.springframework.data.domain.Pageable;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.util.List;
+
+/**
+ * 上传文件Service。
+ */
+public interface UploadFileService {
+    /**
+     * 上传文件。
+     * @param file
+     * @param workId 作品Id
+     * @return
+     */
+    UploadFileDto upload(MultipartFile file, Long workId);
+
+    /**
+     * 获取上传文件
+     * @param hash 文件名hash值
+     * @return
+     */
+    UploadFileDto getUploadFile(String hash);
+
+    /**
+     * 获取文件数量
+     * @param uploadFileDto
+     * @return
+     */
+    Long count(UploadFileDto uploadFileDto);
+
+    /**
+     * 分页查询文件。
+     * @param uploadFileDto
+     * @param pageable
+     * @return
+     */
+    List<UploadFileDto> listFiles(UploadFileDto uploadFileDto, Pageable pageable);
+}
+package com.bsth.luban_springboot2.service.impl;
+
+import com.bsth.luban_springboot2.dto.UploadFileDto;
+import com.bsth.luban_springboot2.entity.UploadFile;
+import com.bsth.luban_springboot2.repo.UploadFileRepo;
+import com.bsth.luban_springboot2.service.UploadFileService;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.data.domain.Example;
+import org.springframework.data.domain.ExampleMatcher;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Isolation;
+import org.springframework.transaction.annotation.Propagation;
+import org.springframework.transaction.annotation.Transactional;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.io.File;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.UUID;
+
+/**
+ * 上传文件服务实现。
+ */
+@Service
+public class UploadFileServiceImpl implements UploadFileService {
+    /** 日志记录器 */
+    private final static Logger LOG = LoggerFactory.getLogger(UploadFileServiceImpl.class);
+
+    @Autowired
+    private UploadFileRepo uploadFileRepo;
+
+    @Value("${luban_h5.upload.path}")
+    private String uploadPath;
+    @Value("${luban_h5.upload_url.prefix}")
+    private String upload_file_url_prefix;
+
+    @Override
+    @Transactional(propagation = Propagation.REQUIRED, isolation = Isolation.READ_COMMITTED)
+    public UploadFileDto upload(MultipartFile file, Long workId) {
+        File uploadPath_dir = Paths.get(this.uploadPath).toFile();
+        if (!uploadPath_dir.exists()) {
+            throw new RuntimeException("配置的服务端上传路径不存在，请管理员后台创建！");
+        }
+        if (!uploadPath_dir.isDirectory()) {
+            throw new RuntimeException("配置的服务端路径不是目录，请重新配置！");
+        }
+
+        UploadFile uploadFile = new UploadFile();
+        uploadFile.setName(file.getOriginalFilename());
+        uploadFile.setHash(UUID.randomUUID().toString().replaceAll("-", "")); // 去除UUID中的-
+        uploadFile.setExt(uploadFile.getName().substring(uploadFile.getName().lastIndexOf(".")));
+        uploadFile.setMime(file.getContentType());
+        uploadFile.setSize(Double.toString(file.getSize() / 1000));
+        uploadFile.setUrl(Paths.get(upload_file_url_prefix, uploadFile.getHash()).toString());
+
+        try {
+            File localFilePath = Paths.get(uploadPath, uploadFile.getHash() + uploadFile.getExt()).toFile();
+            file.transferTo(localFilePath);
+            uploadFile.setRealPath(localFilePath.toString()); // 后端保存的路径
+        } catch (Exception exp) {
+            exp.printStackTrace();
+            throw new RuntimeException("上传文件失败！", exp);
+        }
+
+        // 确定是否封面图
+        if (workId == null) {
+            uploadFile.setCover(Boolean.FALSE);
+        } else {
+            uploadFile.setCover(Boolean.TRUE);
+        }
+
+        uploadFile = uploadFileRepo.save(uploadFile);
+
+        UploadFileDto uploadFileDto = UploadFileDto.builder()
+                .id(uploadFile.getId())
+                .name(uploadFile.getName())
+                .size(uploadFile.getSize())
+                .hash(uploadFile.getHash())
+                .ext(uploadFile.getExt())
+                .mime(uploadFile.getMime())
+                .url(uploadFile.getUrl())
+                .createTime(uploadFile.getCreateTime())
+                .updateTime(uploadFile.getUpdateTime())
+                .provider(uploadFile.getProvider())
+                .providerMetadata(uploadFile.getProviderMetadata())
+                .related(new ArrayList())
+                .sha256(uploadFile.getSha256())
+                .build();
+
+        return uploadFileDto;
+    }
+
+    @Override
+    public UploadFileDto getUploadFile(String hash) {
+        UploadFile uploadFile = this.uploadFileRepo.findByHash(hash);
+        if (uploadFile == null) {
+            LOG.warn("上传文件hash={}，不存在！", hash);
+            return UploadFileDto.builder().build();
+        }
+
+        // 1、获取mime类型
+        String[] types = uploadFile.getMime().split("/");
+        String mimeType = types[0];
+        String mimeSubType = types[1];
+
+        // 2、获取上传文件bytes
+        byte[] uploadFileBytes = null;
+        File file = new File(uploadFile.getRealPath());
+        if (!file.exists()) {
+            LOG.warn("上传文件realPath={}，不存在！", uploadFile.getRealPath());
+            return UploadFileDto.builder().build();
+        } else {
+            try {
+                uploadFileBytes = Files.readAllBytes(file.toPath());
+            } catch (Exception exp) {
+                exp.printStackTrace();
+            }
+
+            return UploadFileDto.builder()
+                    .name(uploadFile.getName())
+                    .hash(uploadFile.getHash())
+                    .bytes(uploadFileBytes)
+                    .mimeType(mimeType)
+                    .mimeSubType(mimeSubType)
+                    .build();
+        }
+
+
+    }
+
+    @Override
+    public Long count(UploadFileDto uploadFileDto) {
+        // 不包括作品封面图
+        UploadFile uploadFile = new UploadFile();
+        uploadFile.setCover(uploadFileDto.getCover());
+        uploadFile.setCreateTime(null);
+        uploadFile.setUpdateTime(null);
+        Example<UploadFile> example = Example.of(uploadFile);
+        return this.uploadFileRepo.count(example);
+    }
+
+    @Override
+    public List<UploadFileDto> listFiles(UploadFileDto uploadFileDto, Pageable pageable) {
+        // 不包括作品封面图
+        UploadFile uploadFile = new UploadFile();
+        uploadFile.setCover(uploadFileDto.getCover());
+        uploadFile.setMime(uploadFileDto.getMime() == null ? "image" : uploadFileDto.getMime());
+        uploadFile.setCreateTime(null);
+        uploadFile.setUpdateTime(null);
+        ExampleMatcher matcher = ExampleMatcher.matching()
+                .withMatcher("mime", ExampleMatcher.GenericPropertyMatchers.startsWith()); // like {mime}%
+        Example<UploadFile> example = Example.of(uploadFile, matcher);
+        Page<UploadFile> uploadFilePage = this.uploadFileRepo.findAll(example, pageable);
+        Page<UploadFileDto> uploadFileDtoPage = uploadFilePage.map((uploadFile_source) -> {
+            UploadFileDto uploadFileDto_covert = UploadFileDto.builder()
+                    .id(uploadFile_source.getId())
+                    .name(uploadFile_source.getName())
+                    .size(uploadFile_source.getSize())
+                    .hash(uploadFile_source.getHash())
+                    .ext(uploadFile_source.getExt())
+                    .mime(uploadFile_source.getMime())
+                    .url(uploadFile_source.getUrl())
+                    .createTime(uploadFile_source.getCreateTime())
+                    .updateTime(uploadFile_source.getUpdateTime())
+                    .provider(uploadFile_source.getProvider())
+                    .providerMetadata(uploadFile_source.getProviderMetadata())
+                    .related(new ArrayList())
+                    .sha256(uploadFile_source.getSha256())
+                    .build();
+            return uploadFileDto_covert;
+        });
+
+        return uploadFileDtoPage.getContent();
+    }
+}
@@ -15,9 +15,9 @@ spring.config.activate.on-profile=mysql_db_config
 # 数据库url连接字符串
 # serverTimezone参数解决数据库时区不一致的问题
 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
-#spring.datasource.url=jdbc:mysql://127.0.0.1/luban_h5?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8
-#spring.datasource.username=root
-#spring.datasource.password=
-spring.datasource.url=jdbc:mysql://192.168.168.169/bsth-ebus_stop_board?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8
+spring.datasource.url=jdbc:mysql://127.0.0.1/luban_h5?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8
 spring.datasource.username=root
-spring.datasource.password=root2jsp
+spring.datasource.password=
+#spring.datasource.url=jdbc:mysql://192.168.168.169/bsth-ebus_stop_board?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8
+#spring.datasource.username=root
+#spring.datasource.password=root2jsp
@@ -22,11 +22,21 @@ spring.profiles.active=prod
 logging.level.com.zaxxer.hikari.HikariConfig=DEBUG
 # logging.level.com.zaxxer.hikari=TRACE
+# 文件上传单个文件大小
+spring.servlet.multipart.enabled=true
+spring.servlet.multipart.file-size-threshold=0
+spring.servlet.multipart.max-file-size=100MB
+spring.servlet.multipart.max-request-size=100MB
+
 #--------------- 鲁班h5相关操作配置 ------------#
 ## zip打包来源文件根路径（目录）
 luban_h5.zip_page.source_root_path=/Users/xu/resource/project_code/bsth_project/bsth_ebus/luban_springboot2/src/main/resources/static
 ## 目标zip文件存放路径（目录）
-luban_h5.zip_page.dest_path=/Users/xu/resource/project_code/runtime_temp/zip_pages
+luban_h5.zip_page.dest_path=/Users/xu/resource/project_code/bsth_project/bsth_ebus/temp_files/zip_pages
+## 上传文件的存放路径
+luban_h5.upload.path=/Users/xu/resource/project_code/bsth_project/bsth_ebus/temp_files/upload_files
+## 上传文件获取url前缀
+luban_h5.upload_url.prefix=/upload/getFile
 #luban_h5.zip_page.source_root_path=D:/apache-tomcat-8.5.64/webapps/lubanh5/WEB-INF/classes/static
-#luban_h5.zip_page.dest_path=D:/zip_pages
 \ No newline at end of file
+#luban_h5.zip_page.dest_path=D:/zip_pages