在前面的文章中我们对Spring Boot的配置以及日志配置有了大概的了解，在我们搭建完成第一个Spring Boot项目之后也提到了一个概念就是RestFul风格的接口开发。下面我们就来详细介绍一下使用Spring Boot如何去开发一个RestFul的Web接口。

准备

在开发接口之前，需要引入的就是Web模块的场景启动器以及对应的自动配置。而这些操作是在我们引入POM依赖之后由Spring Boot框架自动创建的，所以不需要在添加其他的注解或者是配置。需要引入的配置如下。

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

虽然只是引入了这样一个简单的依赖，但是根据我们之前研究配置依赖的时候的分析，可以知道，这个场景启动器引入的依赖还包括Spring 、Spring MVC相关的依赖。对于场景启动器自动依赖自动配置相关的内容，我们在后续的深入分析中还会详细讲到，这里就先不讨论深层次的东西。

第一个接口开发

第一步，需要先创建一个实体类对象，这个对象主要是用来测试接口调用之后的内容展示。

public class UserInfo {
    private String username;
    private String phone;
    private String idcard;
    private Integer age;
    private Date birthday;

第二步，编写测试的Controller对象，并对实体类对象进行传值。

@RestController
@RequestMapping("/test")
public class UserInfoController {


    @GetMapping("/getUserInfo")
    public UserInfo getUserInfo(){
        UserInfo userInfo = new UserInfo();
        userInfo.setUsername("张三丰");
        userInfo.setAge(102);
        userInfo.setPhone("12345678971");
        userInfo.setIdcard("123456789789456123");
        userInfo.setBirthday(new Date());

        return userInfo;
    }
}

第三步，接口编写完成之后可以在浏览器中调用
http://localhost:8080/test/getUserInfo 接口会卡看到返回内容如下所示。

{
	username: "张三丰",
	phone: "12345678971",
	idcard: "123456789789456123",
	age: 102,
	birthday: "2022-11-01T00:51:19.365+00:00"
}

到这里，我们的第一个Web接口就算开发完成了。

但是我们发现UserInfo 的birthday属性的时间格式并不是我们需要的时间格式，那么我们怎么对返回结果进行格式化呢？

对返回结果进行格式化处理

在前后端分离的项目中，大部分的接口调用都是通过JSON数据格式进行返回的，既然是JSON数据那么我们就需要对一些特殊的数据进行处理。而在Spring Boot中默认提供Jackson框架对返回的结果进行处理，在我们引入Web场景启动器的时候这个依赖已经被引入到了依赖中。如下图所示

图中内容也是引入了一个启动器，这也就意味着我们可以通过配置项修改其中的一些配置内容，例如在Spring Boot 中默认使用的Jackson的自动配置类是JacksonAutoConfiguration，在这个配置类中引入了一个配置类JacksonProperties提供了一些配置内容，其中一个就是对于日期时间格式进行配置。如下所示。

@ConfigurationProperties(prefix = "spring.jackson")
public class JacksonProperties {

	/**
	 * Date format string or a fully-qualified date format class name. For instance,
	 * 'yyyy-MM-dd HH:mm:ss'.
	 */
	private String dateFormat;

所以根据之前的分析，我们可以通过在配置文件中添加如下的配置项对时间格式进行配置。

spring:
  jackson:
    date-format: yyyy-MM-dd hh:mm:ss

添加完配置之后，我们会发现，时间格式虽然发生了变化，但是时间却不准确，如下所示。那是因为我们没有制定计算时间的时区。

{
	username: "张三丰",
	phone: "12345678971",
	idcard: "123456789789456123",
	age: 102,
	birthday: "2022-11-01 01:06:32"
}

修改配置如下

spring:
  jackson:
    date-format: yyyy-MM-dd hh:mm:ss
    time-zone: GMT+8

这里我们加入了时区的配置，所以说时间也就发生了变化。

{
	username: "张三丰",
	phone: "12345678971",
	idcard: "123456789789456123",
	age: 102,
	birthday: "2022-11-01 09:06:32"
}

当然，在使用Jackson的时候，还有一些其他配置，这些配置的前缀都是spring.jackson开头，我们可以从JacksonProperties类中获取到对应的配置属性。当然除了可以在配置文件中进行配置之外，也可以通过配置类的方式进行配置。这就需要我们对JacksonAutoConfiguration类的源码进行分析了，由于这里还没有对于Spring Boot的自动注入的原理进行分析，所以这里就先不赘述这些内容，在我们分析完Spring Boot 自动注入的原理之后，我们再来分析这块的内容。