数据存储

快速导航

概览

在介绍以下几种数据库之前少不了先说下Spring家族的spring-data，适用于关系型和非关系型数据库，简化了配置和数据库访问。例如，Spring Data JPA、Spring Data MongoDB、Spring Data Redis等
MySql
MongoDB
Redis

概览

在介绍以下几种数据库之前少不了先说下Spring家族的spring-data，适用于关系型和非关系型数据库，简化了配置和数据库访问。例如，Spring Data JPA、Spring Data MongoDB、Spring Data Redis等

Spring Data 官网，推荐去官网看看。

mysql

Mysql数据库这里要用到Spring-Data-Jpa，它是JPA规范下提供的Repository层的实现，可以使用Hibernate、OpenJpa等框架进行开发。关于JPA规范，它的全称Java Persistence API(Java持久化API)一个ORM规范，具体实现还是Hibernate等，JPA为我们提供了CRUD的接口。

常用方法

更多详细方法及使用参考官方文档 https://docs.spring.io/spring-data/jpa/docs/current/reference/html/

save(): 保存、更新
delete: 删除，或者deleteByProperty Property为字段属性名
findOne(): 通过id查询
findByProperty(type Property): 通过属性查询，例如表中的name字段查询，实现方式 findByName(String name)
findAll(): 查询所有数据
findAll(new PageRequest(1, 20)): 分页

添加依赖

项目根目录 pom.xml 添加依赖 spring-boot-starter-data-jpa mysql-connector-java

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

修改配置文件

application.yml

mysql相关配置
datasource 数据源
- driver-class-name 驱动名称
- `url 数据库地址（hots:port/database）
- username 数据库用户名
- password 数据库密码

spring:
    datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/dbUser?useUnicode=true&characterEncoding=utf-8&useSSL=true
        username: root
        password: 123456

jpa相关配置
hibernate: 相关配置信息有以下几种类型
- ddl-auto:create: 每次运行加载不管之前是否有数据都会自动创建一个表，会造成数据丢失。
- ddl-auto:update: 第一次加载会创建新的数据接口，之后只会在原有表基础之上进行迭代。
- ddl-auto:validate: 验证类里面的属性与表结构是否一致。
- ddl-auto:create-drop: 每次退出时删除。
- ddl-auto:node: 默认什么都不做。
show-sql: 是否打印SQL，在开发时可以开启方便调试。
database: 数据库类型。

spring:
    jpa:
        hibernate:
            ddl-auto: update
        show-sql: true
        database: mysql

实例

Spring-Data-Jpa实现CRUD操作

实现以下需求：

GET: 查询所有用户信息
GET: 根据年龄获取用户信息
POST: 增加用户(姓名、年龄)
PUT: 修改用户
DELETE: 删除用户

创建表

就是创建存储的User实体（User类）

是不需要手动去数据库创建表的，以下创建的User类和定义的属性会对应到数据库中的表和字段，这就需要应用jpa的特性了，看下以下注解。

@Entity: 代表此类映射为数据库的表结构
@Id: 指定一个主键
@GeneratedValue: 配置主键相关信息
- Table: 使用一个特定的数据库表来保存主键
- IDENTITY: 数据库自动生成
- AUTO: 主键由程序控制，默认值
- SEQUENCE: 通过数据库的序列产生主键, MYSQL不支持，部分数据库(Oracle,PostgreSQL,DB2)支持序列对象


```java
@Entity
public class User {
    @Id
    @GeneratedValue
    private Integer id;
    private String name;
    private Integer age;
    public User() {
    }
    // getter、setter方法此处省略，代码可参考本节源码
}

创建数据访问接口

创建接口User的数据访问UserRepository继承于JpaRepository，可以在这个接口里实现UserRepository的扩展

UserRepository.java


public interface UserRepository extends JpaRepository<User, Integer> {
    /**
     * 扩展，通过名字查询
     * @param name
     * @return
     */
    public List<User> findByName(String name);
}

创建UserController


```java
package com.angelo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
import java.util.Optional;
@RestController
public class UserController {
    @Autowired
    private UserRepository userRepository;
}

保存一个用户

@RestController
public class UserController {
    // ... 以上内容忽略
    /**
     * 保存一个用户
     * @param name
     * @param age
     * @return
     */
    @PostMapping(value = "/user")
    public User userAdd(@RequestBody User userParams) {
        User user = new User();
        user.setName(userParams.getName());
        user.setAge(userParams.getAge());
        return userRepository.save(user);
    }
}

postman测试

curl -X POST \
  http://127.0.0.1:8080/user \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'postman-token: e0832f99-8a03-e260-4388-b3f60dc2d0c4' \
  -d '{
    "name": "张三",
    "age": 18
}'

{
    "id": 3,
    "name": "张三",
    "age": 18
}

查询用户列表

@RestController
public class UserController {
  // ... 以上内容忽略
  /**
   * 查询用户列表
   * @return
   */
  @RequestMapping(value = "/user/list")
  public List<User> userList() {
      return userRepository.findAll();
  }
}

postman测试

curl -X GET \
  http://127.0.0.1:8080/user/list \
  -H 'cache-control: no-cache' \
  -H 'postman-token: 1fca1e6c-820e-b5bd-952f-2ab658b084a5'

返回数据

[
    {
        "id": 1,
        "name": "张三",
        "age": 18
    }
]

根据id查找一个用户

注意， spring-data-jpa 2.0.5.RELEASE 版本之后获取单个对象的数据源需要用findById()，SpringBoot1.x版本可以使用findOne()

@RestController
public class UserController {
    // ... 以上内容忽略
    /**
     * 根据id查找一个用户
     * @param id
     * @return
     */
    @RequestMapping(value = "/user/{id}")
    public Optional<User> userFindOne(@PathVariable("id") Integer id) {
        return userRepository.findById(id);
    }
}

postman测试

curl -X GET \
  http://127.0.0.1:8080/user/1 \
  -H 'cache-control: no-cache' \
  -H 'postman-token: 801e22f4-73a1-6f1d-4207-0079d5a31004'

返回数据

{
    "id": 1,
    "name": "张三",
    "age": 18
}

根据name查找用户

@RestController
public class UserController {
    // ... 以上内容忽略
    /**
     * 根据name获取用户信息
     * @param name
     * @return
     */
    @RequestMapping(value = "/user/name", method = RequestMethod.GET)
    public List<User> findUserListByName(@RequestParam(name="name",defaultValue="") String name) {
        return userRepository.findByName(name);
    }
}

postman测试

curl -X GET \
  'http://127.0.0.1:8080/user/name?name=%E5%BC%A0%E4%B8%89' \
  -H 'cache-control: no-cache' \
  -H 'postman-token: 4b4a0850-50f5-3fb2-7137-a44f555e9b49'

返回数据

[
    {
        "id": 1,
        "name": "张三",
        "age": 18
    }
]

更新用户信息

@RestController
public class UserController {
    // ... 以上内容忽略
    /**
     * 更新用户信息
     * @param id
     * @param name
     * @param age
     * @return
     */
    @PutMapping(value = "/user/{id}")
    public User userUpdate(
            @PathVariable("id") Integer id,
            @RequestParam("name") String name,
            @RequestParam("age") Integer age
    ) {
        User user = new User();
        user.setId(id);
        user.setName(name);
        user.setAge(age);
        return userRepository.save(user);
    }
}

postman测试

curl -X PUT \
  http://127.0.0.1:8080/user/1 \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -H 'postman-token: 2b717e08-8c07-2dc7-c592-81358617625b' \
  -d 'name=%E6%9D%8E%E5%9B%9B&age=20'

返回数据

{
    "id": 1,
    "name": "李四",
    "age": 20
}

删除一个用户信息

@RestController
public class UserController {
    // ... 以上内容忽略
    /**
     * 删除一个用户信息
     * @param id
     */
    @DeleteMapping(value = "/user/{id}")
    public void deleteUser(@PathVariable("id") Integer id) {
        userRepository.deleteById(id);
    }
}

postman测试，删除数据返回为空

curl -X DELETE \
  http://127.0.0.1:8080/user/1 \
  -H 'cache-control: no-cache' \
  -H 'postman-token: 47e13a68-b69a-bf7b-b14c-94ce82865496'

问题排错

问题1:配置datasource可能报以下错误，这是因为添加了数据库依赖，autoconfig会读取数据源配置，因为新建的项目没有配置数据源（问题重点所在）因此抛此异常。

Description:
Failed to configure a DataSource: 'url' attribute is not specified and no embedded datasource could be configured.
Reason: Failed to determine a suitable driver class
Action:
Consider the following:
    If you want an embedded database (H2, HSQL or Derby), please put it on the classpath.
    If you have database settings to be loaded from a particular profile you may need to activate it (no profiles are currently active).
Process finished with exit code 1

在启动类的@SpringBootApplication注解上加上exclude= {DataSourceAutoConfiguration.class}，将会解除自动加载DataSourceAutoConfiguration。同样还会引发另外一个问题，例如本实例中配置文件里的数据库就不会自动去创建链接。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
@SpringBootApplication(exclude= {DataSourceAutoConfiguration.class})
public class UserApplication { // 启动类
    public static void main(String[] args) {
        SpringApplication.run(UserApplication.class, args);
    }
}

问题2:

链接mysql，启动时候警告以下内容，原因是MySql高版本需要指明是否进行SSL链接

WARN: Establishing SSL connection without server’s identity verification is not recommended. According to MySQL 5.5.45+, 5.6.26+ and 5.7.6+ requirements SSL connection must be established by default if explicit option isn’t set. For compliance with existing applications not using SSL the verifyServerCertificate property is set to ‘false’. You need either to explicitly disable SSL by setting useSSL=false, or set useSSL=true and provide truststore for server certificate verification.

改正之前代码

spring:
    datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/dbUser
        username: root
        password: 123456

改正之后代码，useSSL设置为true都可以

spring:
    datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/dbUser?useUnicode=true&characterEncoding=utf-8&useSSL=false
        username: root
        password: 123456

源码地址 https://github.com/Q-Angelo/SpringBoot-Course/tree/master/chapter2/chapter2-1

mongodb

简介

MongoDB 是一个基于分布式文件存储的数据库。由 C++ 语言编写。旨在为 WEB 应用提供可扩展的高性能数据存储解决方案，官方解释。在NoSql数据库中还是比较优秀的一款数据库，且官方网站现在已经逐步开始支持中文版了。 MongoDB 中文版

之前MySql介绍了Spring Data Jpa，对于MongoDB，Spring也提供了强大的支持Spring Data MongoDB，这个项目提供了与MongoDB文档数据库的集成。

注意 在开始之前先开启你的mongod，对于mongodb安装启动有疑问的可以参考这里 Mac系统下安装MongoDB

添加mongodb依赖

项目根目录 pom.xml 添加依赖 spring-boot-starter-data-mongodb

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

修改配置文件mongodb相关配置

mongo2.4以上版本：
- uri: 数据库链接地址 mongodb://username:password@ip:host
mongo2.4以下版本：
- host: 127.0.0.1
- port: 27017
- username: root
- password: root
- database: test

application.yml

spring:
    data:
        mongodb:
            uri: mongodb://127.0.0.1:27017
            database: test

定义集合模型

关于Spring Data MongoDB更多注解及使用参考官方文档

在项目启动时候，以下定义的字段会对应到数据库中的数据结构，注意要添加@Document注解。

@Document: 标注于实体类上表明由mongo来维护该集合，默认集合名为类名还可手动指定集合名@Document(collection=user)
@Id: 主键，自带索引由mongo生成对应mongo中的_id字段(ObjectId)
@Indexed: 设置该字段索引，提高查询效率，设置参数(unique=true)为唯一索引，默认为false

package com.angelo;
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.index.Indexed;
import org.springframework.data.mongodb.core.mapping.Document;
@Document
public class User {
    @Id
    private String id;
    @Indexed
    private String name;
    private Integer age;
    @Indexed(unique = true)
    private String idCard;
    public User() {
    }
    // 以下getter、setter方法，代码可以参考本节源码
}

创建继承于mongorepository的数据访问对象

创建UserRepository继承于MongoRepository，当然你也可以使用JpaRepository或MongoRepository，这些接口扩展了mongodb的CRUD操作的通用接口，此外还公开了底层持久化技术的功能，供我们扩展。

例如以下findById，MongoRepository提供的接口为Long类型，显然我这里使用mongodb自动生成的ObjectId，自然是不行了，因此扩展了该方法。

UserRepository.java

package com.angelo;
import org.springframework.data.mongodb.repository.MongoRepository;
import java.util.List;
public interface UserRepository extends MongoRepository<User, Long> {
    User findById(String id);
    List <User> deleteById(String id);
}

创建控制层实现对数据的增删改查

此处操作Mongodb的增删改查和之前讨论的MySql一样，以下给出代码示例

package com.angelo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
public class UserController {
    @Autowired
    private UserRepository userRepository;
    /**
     * 查询用户列表
     * @return
     */
    @GetMapping(value = "/user/list")
    public List<User> userList() {
        return userRepository.findAll();
    }
    @GetMapping(value = "/user/info")
    public User findUserById(@RequestParam("id") String id) {
        return userRepository.findById(id);
    }
    /**
     * 创建用户信息
     */
    @PostMapping(value = "/user")
    public User createUser(@RequestBody User params) {
        User user = new User();
        user.setName(params.getName());
        user.setAge(params.getAge());
        user.setIdCard(params.getIdCard());
        return userRepository.save(user);
    }
    /**
     * 更新用户信息
     */
    @PutMapping(value = "/user/{id}")
    public User updateUser(@PathVariable("id") String id, @RequestParam("name") String name, @RequestParam("age") Integer age,
        @RequestParam("idCard") String idCard) {
        User user = new User();
        user.setId(id);
        user.setName(name);
        user.setAge(age);
        user.setIdCard(idCard);
        return userRepository.save(user);
    }
    /**
     * 删除用户信息
     * MongoRepository提供的原生方法会报deleteById(java.lang.long) in CurdRepository cannot be applied to (java.lang.string)，此处定义的id为String类型显然不符，在UserRepository接口中进行了重写，
     */
    @DeleteMapping(value = "/user/{id}")
    public void deleteUserById(@PathVariable("id") String id) {
        userRepository.deleteById(id);
    }
}

源码地址 https://github.com/Q-Angelo/SpringBoot-Course/tree/master/chapter2/chapter2-2

数据存储

数据存储

快速导航

概览

MySql

MongoDB

Redis

概览

mysql

常用方法

添加依赖

修改配置文件

mysql相关配置

jpa相关配置

实例

Spring-Data-Jpa实现CRUD操作

创建表

创建数据访问接口

创建UserController

问题排错

mongodb

简介

添加mongodb依赖

修改配置文件mongodb相关配置

定义集合模型

创建继承于mongorepository的数据访问对象

创建控制层实现对数据的增删改查