构建一个REST风格的Web服务

你需要什么

• 大约15分钟
• IntelliJ IDEA或其他编辑器
• JDK 1.8或更高版本
• Maven 3.2+

你会建立什么

您将在以下地址构建一个将接受HTTP GET请求的服务：

http://localhost:8080/greeting

会返回一个JSON 格式的数据：

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

您可以使用查询字符串中的可选名称参数来自定义问候语：

http://localhost:8080/greeting?name=User

名称参数值覆盖“World”的默认值，并反映在响应中：

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

项目步骤

1、添加maven依赖

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

2、新建表现层类

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;
    }
}

3、新建controller

import java.util.concurrent.atomic.AtomicLong;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class GreetingController {

    private static final String template = "Hello, %s!";
    private final AtomicLong counter = new AtomicLong();

    @RequestMapping("/greeting")
    public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) {
        return new Greeting(counter.incrementAndGet(),
                            String.format(template, name));
    }
}

• @RequestMapping注释可确保对/greeting的HTTP请求映射到greeting（）方法。
• @RequestParam将查询字符串参数名称的值绑定到greeting（）方法的name参数中。如果请求中缺少name参数，则使用“World”的defaultValue。
• 此代码使用Spring 4的新的@RestController注释，该注释将类标记为控制器，其中每个方法都返回一个域对象而不是视图（view）。它是@Controller和@ResponseBody的缩写。
• Greeting对象必须转换为JSON。由于Spring的HTTP消息转换器支持，您不需要手动执行此转换。因为Jackson 2在类路径上，自动选择Spring的MappingJackson2HttpMessageConverter将Greeting实例转换为JSON。

上面的例子没有指定GET与PUT，POST等等，因为@RequestMapping默认映射所有的HTTP操作。使用@RequestMapping（method = GET）来缩小这个映射。

4、新建启动方法

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

@SpringBootApplication
public class Application {

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

@SpringBootApplication是一个方便的注释，它包含了以下所有内容：

package org.springframework.boot.autoconfigure;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.boot.context.TypeExcludeFilter;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.FilterType;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.core.annotation.AliasFor;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration    // 就是 @Configuration 应用程序上下文的bean定义的来源
@EnableAutoConfiguration    // based on classpath settings, other beans, and various property settings. 依据类路径设置、其他beans以及各种属性配置文件来配置bean
@ComponentScan(             //告诉Spring在当前类所在包中查找其他组件，配置和服务，以及找到控制器
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
    @AliasFor(
        annotation = EnableAutoConfiguration.class,
        attribute = "exclude"
    )
    Class<?>[] exclude() default {};

    @AliasFor(
        annotation = EnableAutoConfiguration.class,
        attribute = "excludeName"
    )
    String[] excludeName() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackages"
    )
    String[] scanBasePackages() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackageClasses"
    )
    Class<?>[] scanBasePackageClasses() default {};
}

除此之外，通常你会为Spring MVC应用程序添加@EnableWebMvc，但Spring Boot会在类路径中看到spring-webmvc时自动添加它。

测试

ok ，到这就完了，接下来可以启动项目运行 main() 方法，然后按照文首自行测试一把。

原文地址 https://spring.io/guides/gs/rest-service/#initial