[Spring-boot] No.1 做一个RESTful风格的Web服务

一、目标 （Goal）：

我们将要编写一个接收HTTP GET 请求的后台服务，如下：
http://localhost:8080/greeting
以及返回一个JSON格式的“问候”：
{"id":1,"content":"Hello, World!"}
并且我们可以带着一个参数（name）请求：
http://localhost:8080/greeting?name=Boy
然后我们将得到 "Hello, Boy!"的“问候”:
{"id":1,"content":"Hello, User!"}
以上就是我们本次所要做的全部内容，Let's start it！

二、工具

• IDE：我使用的是Intellij IDEA 2016.1.3；Eclipse也很不错；
• JDK 1.8 及以后
• Maven 3.0+ （或者Gradle 2.3）；
• 也可以从 https://start.spring.io/ 直接自定义一个spring-boot工程文件并下载使用；注意Dependencies处需要添加Web依赖，其他等以后用到可以另作添加；

三、Coding

先看一下我们需要返回的数据格式（JSON）：

{
    "id": 1,
    "content": "Hello, World!"
}

那么为了与之对应，我们就先编写一个Greeting类：
路径：src/main/java/com/fd/restService/model/Greeting.java

package com.fd.restService.model;

public class Greeting {
    private final long id;
    private final String content;

    public Greeting(long id, String content) {
        this.id = id;
        this.content = content;
    }

    public long getId() {
        return id;
    }

    public String getContent() {
        return content;
    }
}

Spring可以通过 Jackson JSON 库，自动地将Greeting实例转化为上述JSON形式。

接下来创建一个控制器（Controller）:

在Spring应用中，HTTP请求将由控制器（Controller）接收，并进行相应处理。@RestController将GreetingController类标注为一个控制器。

路径：src/main/java/com/fd/restService/controller/GreetingController.java

package com.fd.restService.controller;

import com.fd.demo.model.Greeting;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.concurrent.atomic.AtomicLong;

@RestController    //标注为控制器
public class GreetingController {

    private static final String template = "Hello, %s!";     //返回格式
    private final AtomicLong counter = new AtomicLong();  //线程安全的Long

    @RequestMapping("/greeting")   //设置访问路径
    //设置一个请求参数name，不传则默认传“World”字符串
    public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) {   
        //简单的返回一个Greeting实例，而Spring会将其转化为JSON格式
        return new Greeting(counter.incrementAndGet(), String.format(template, name));    
    }
}

注意几个注解的用法：

• @RestController：包含了@Controller和@ResponseBody；
• @RequestMapping：value属性表示访问路径设置，method属性设置HTTP方法（如GET、POST、PUT等）；
  如：@RequestMapping(value = "/greeting",method = RequestMethod.GET)
• @RequestParam：常用有value、defaultValue、required属性等

注：与传统的MVC（通常返回一个HTML视图）不同，RESTful风格的Web服务注重数据的交互，所以在返回的HTTP消息体中只有简单的数据本地（JSON格式简洁且易理解），这样也便利了前后端的分离。

运行前的工作：

在通常的工作中，我们都是通过打包成war包然后部署到远程服务器上的这么一个步骤。而spring有一套更简便运行web服务的策略：

将所有需要运行的类都各自打包成一个独立的jar包，并设置一个main()函数作为程序入口。然后就可以通过spring的内置Tomcat容器部署运行你的服务。

以上都是策略，不需要我们实际依次去操作。
我们只要提供一个程序入口类：
路径：src/main/java/com/fd/restService/ResTfulServiceApplication.java

package com.fd.restService;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ResTfulServiceApplication {

    public static void main(String[] args) {
        SpringApplication.run(ResTfulServiceApplication.class, args);
    }
}

• @SpringBootApplication注解是以下几个注解的总和：
  1.@Configuration：它告知 Spring 容器这个类是一个拥有 bean 定义和依赖项的配置类；
  2.@EnableAutoConfiguration：暗地里定义了一个基础的包路径，Spring Boot会在该包路径来搜索类；
  3.@EnableWebMvc
  4.@ComponentScan：让Spring去寻找包内其他的组件、配置以及服务，在这里也就是找到我们的GreetingController 类；

最后，打jar包运行或者依赖IDE运行后：

Intellij IDEA 运行方式

日志信息

运行成功后在浏览器中输入：
http://localhost:8080/greeting
得到返回结果：
{"id":1,"content":"Hello, World!"}

参考文档

https://spring.io/guides/gs/rest-service/