MySQL-MyBatis -案例补充-开发规范&文件上传等

1. 开发规范

1.1 REST

REST（Representational State Transfer），表述性状态转换，它是一种软件架构风格。

通过URL定位要操作的资源，通过HTTP动词(请求方式)来描述具体的操作。

在REST风格的URL中，通过四种请求方式，来操作数据的增删改查。

• GET ： 查询
• POST ：新增
• PUT ：修改
• DELETE ：删除

注意事项：

• REST是风格，是约定方式，约定不是规定，可以打破
• 描述模块的功能通常使用复数，也就是加s的格式来描述，表示此类资源，而非单个资源。如：users、emps、books…

1.2 统一响应结果

前后端工程在进行交互时，使用统一响应结果 Result。

package com.itheima.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result {
    private Integer code;//响应码，1 代表成功; 0 代表失败
    private String msg;  //响应信息 描述字符串
    private Object data; //返回的数据

    //增删改 成功响应
    public static Result success(){
        return new Result(1,"success",null);
    }
    //查询 成功响应
    public static Result success(Object data){
        return new Result(1,"success",data);
    }
    //失败响应
    public static Result error(String msg){
        return new Result(0,msg,null);
    }
}

1.3思路分析

采用三层架构的方式进行分析
通用的三层架构图

2. 分页插件

MyBatis最主流的插件PageHelper。
PageHelper是Mybatis的一款功能强大、方便易用的分页插件，支持任何形式的单标、多表的分页查询。
不需要下载，直接在springboot项目中引入依赖即可。

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.4.2</version>
</dependency>

3. 文件上传

文件上传，是指将本地图片、视频、音频等文件上传到服务器，供其他用户浏览或下载的过程。

上传涉及到两个程序：

1. 前端服务程序
2. 后端服务程序

3.1 前端客户/网页端程序

上传文件的原始form表单，要求表单必须具备以下三点（上传文件页面三要素）：

• 表单必须有file域，用于选择要上传的文件
• 表单提交方式必须为POST
• 表单的编码类型enctype必须要设置为：multipart/form-data

<form action="/upload" method="post" enctype="multipart/form-data">
	姓名: <input type="text" name="username"><br>
    年龄: <input type="text" name="age"><br>
    头像: <input type="file" name="image"><br>
    <input type="submit" value="提交">
</form>

3.2 后端服务端程序

• 首先在服务端定义这么一个controller，用来进行文件上传，然后在controller当中定义一个方法来处理/upload 请求
• 在定义的方法中接收提交过来的数据 （方法中的形参名和请求参数的名字保持一致）
  • 用户名：String name
  • 年龄： Integer age
  • 文件： MultipartFile image

Spring中提供了一个API：MultipartFile，使用这个API就可以来接收到上传的文件

3.3 本地存储

1. 在服务器本地磁盘上创建images目录，用来存储上传的文件（例：E盘创建images目录）
2. 使用MultipartFile类提供的API方法，把临时文件转存到本地磁盘目录下

3.3.1 MultipartFile 常见方法：

• String getOriginalFilename(); //获取原始文件名
• void transferTo(File dest); //将接收的文件转存到磁盘文件中
• long getSize(); //获取文件的大小，单位：字节
• byte[] getBytes(); //获取文件内容的字节数组
• InputStream getInputStream(); //获取接收到的文件内容的输入流

使用UUID类进行生成文件名，解决文件名重复导致的文件覆盖问题

@Slf4j
@RestController
public class UploadController {

    @PostMapping("/upload")
    public Result upload(String username, Integer age, MultipartFile image) throws IOException {
        log.info("文件上传：{},{},{}",username,age,image);

        //获取原始文件名
        String originalFilename = image.getOriginalFilename();

        //构建新的文件名
        String extname = originalFilename.substring(originalFilename.lastIndexOf("."));//文件扩展名
        String newFileName = UUID.randomUUID().toString()+extname;//随机名+文件扩展名

        //将文件存储在服务器的磁盘目录
        image.transferTo(new File("E:/images/"+newFileName));

        return Result.success();
    }

}

除此之外，配置每次上传以及批量上传的限制大小

spring：
  servlet:
    multipart:
      max-file-size: 10MB
      max-request-size: 100MB

缺点：

• 不安全：磁盘如果损坏，所有的文件就会丢失
• 容量有限：如果存储大量的图片，磁盘空间有限(磁盘不可能无限制扩容)
• 无法直接访问

3.4 阿里云OSS

阿里云的使用步骤

3.4.1编写入门程序

参照官方提供的SDK，改造一下，即可实现文件上传功能：
需要更换的数据：

• accessKeyId：阿里云账号AccessKey
• accessKeySecret：阿里云账号AccessKey对应的秘钥
• bucketName：Bucket名称
• objectName：对象名称，在Bucket中存储的对象的名称
• filePath：文件路径

3.4.2 集成阿里云oss

1. 引入阿里云OSS上传文件工具类（由官方的示例代码改造而来）

import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;
import java.io.InputStream;
import java.util.UUID;

@Component
public class AliOSSUtils {
    private String endpoint = "https://oss-cn-shanghai.aliyuncs.com";
    private String accessKeyId = "LTAI5t9MZK8iq5T2Av5GLDxX";
    private String accessKeySecret = "C0IrHzKZGKqU8S7YQcevcotD3Zd5Tc";
    private String bucketName = "web-framework01";

    /**
     * 实现上传图片到OSS
     */
    public String upload(MultipartFile multipartFile) throws IOException {
        // 获取上传的文件的输入流
        InputStream inputStream = multipartFile.getInputStream();

        // 避免文件覆盖
        String originalFilename = multipartFile.getOriginalFilename();
        String fileName = UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf("."));

        //上传文件到 OSS
        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
        ossClient.putObject(bucketName, fileName, inputStream);

        //文件访问路径
        String url = endpoint.split("//")[0] + "//" + bucketName + "." + endpoint.split("//")[1] + "/" + fileName;

        // 关闭ossClient
        ossClient.shutdown();
        return url;// 把上传到oss的路径返回
    }
}

2. 修改UploadController代码：
3. 测试

4 配置文件

4.1 参数配置化

1. 把java文件中的配置信息，写入到 application.properties配置文件中

4.1.1 @Value注解

将外部配置一个一个的注入到要使用的位置，借助@Value 注解通常用于外部配置的属性注入，具体用法为： @Value(“${配置文件中的key}”)
劣势：

• 一个一个的注入，很容易出错
• 修改时工作量大，查找不方便

4.1.2 @ConfigurationProperties 注解

springboot项目中：

1. 需要创建一个实体类，且实体类中的属性名和配置文件当中key的名字必须要一致

   比如：配置文件当中叫endpoints，实体类当中的属性也得叫endpoints，另外实体类当中的属性还需要提供 getter / setter方法

2. 需要将实体类交给Spring的IOC容器管理，成为IOC容器当中的bean对象

3. 在实体类上添加@ConfigurationProperties注解，并通过perfix属性来指定配置参数项的前缀

引入依赖（可以不引入）

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
</dependency>

在引入此依赖后，就会出现oss对象的提示，这项依赖它的作用就是会自动的识别被@Configuration Properties注解标识的bean对象。

与@Value的不同点：

• @Value注解只能一个一个的进行外部属性的注入。
• @ConfigurationProperties可以批量的将外部的属性配置注入到bean对象的属性中。

4.2 配置文件的格式

配置文件有：

• xml文件
• properties文件
• yml/yaml文件

在springboot项目中常用的是yml配置文件，它的优势：

• 容易阅读
• 容易与脚本语言交互
• 以数据为核心，重数据轻格式

4.2.1 yml的基础语法

• 大小写敏感
• 数值前边必须有空格，作为分隔符
• 使用缩进表示层级关系，缩进时，不允许使用Tab键，只能用空格（idea中会自动将Tab转换为空格）
• 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
• #表示注释，从这个字符一直到行尾，都会被解析器忽略