翻译-Building a RESTful Web Service

翻译——使用Spring创建一个RESTful Web Service

创建一个RESTful Web Service

本指南将引导您完成使用Spring创建“hello world” RESTful Web服务的过程

你会建立什么

您将在以下位置创建一个接受HTTP GET请求的服务:

http://localhost:8080/greeting

并用一个JSON表示欢迎:

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

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

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

name参数值覆盖“World”的默认值,并反映在response中:

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

你需要什么

如何完成本指南

像大多数Spring 入门指南一样,您可以从头开始并完成每个步骤,也可以绕过已熟悉的基本设置步骤。 无论哪种方式,你最终都能得到成功的代码。

从头开始 ,请继续阅读使用Gradle构建

跳过这些基础知识 ,请执行以下操作:

完成后 ,您可以根据gs-rest-service/complete中的代码检查结果。

用Gradle构建

用Maven构建

用您的IDE构建

创建一个资源表示类

现在您已经设置了项目和构建系统,您可以创建您的Web服务。

考虑服务交互开始流程。

该服务将处理/greetingGET请求,可选择性地在查询字符串中使用name参数。 GET请求应该在表示问候的正文中返回带有JSON的200 OK响应。 它应该如下所示:

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

id字段是问候语的唯一标识符, content是问候语的文字表示。

为了对问候表示进行建模,您可以创建一个资源表示类。 为idcontent数据提供一个普通的java对象,其中包含字段,构造函数和访问器:

src/main/java/hello/Greeting.java

package hello;

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。

接下来,您将创建将提供这些问候的资源控制器。

创建一个资源控制器

在Spring构建RESTful Web服务的方法中,HTTP请求由控制器处理。 这些组件可以通过@RestController批注轻松识别,并且GreetingController通过返回Greeting类的新实例来处理/greetingGET请求:

src/main/java/hello/GreetingController.java

package hello;

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()方法。

上面的例子没有指定GETPUTPOST等等,因为@RequestMapping默认映射所有的HTTP操作。 使用@RequestMapping(method=GET)来缩小这个映射。

@RequestParam将查询字符串参数name的值绑定到greeting()方法的name参数中。 此查询字符串参数显式标记为可选(默认情况下为required=true ):如果请求中没有带name参数,则使用defaultValue “World”。

方法体的实现基于counter的下一个值创建并返回一个带有idcontent属性的新Greeting对象,并使用问候template格式化给定name

传统的MVC控制器和上面的RESTful Web服务控制器之间一个主要区别在于HTTP响应主体的创建方式。 这个RESTful Web服务控制器只需填充并返回一个Greeting对象,而不是依赖视图技术将问候数据的服务器端呈现呈现给HTML。 对象数据将作为JSON直接写入HTTP响应。

此代码使用Spring 4的新的@RestController注释,该注释将类标记为控制器,其中每个方法都返回一个域对象而不是视图。 它是@Controller@ResponseBody的缩写。

Greeting对象必须转换为JSON。 由于Spring的HTTP消息转换器支持,您不需要手动执行此转换。 由于Jackson 2位于类路径中, MappingJackson2HttpMessageConverter会自动选择Spring的MappingJackson2HttpMessageConverterGreeting实例转换为JSON。

使应用程序可执行

虽然可以将此服务作为传统WAR文件打包以部署到外部应用程序服务器,但下面演示的更简单的方法会创建独立应用程序。 您将所有内容打包到一个单独的、可执行的JAR文件中,由一个Java main()方法驱动。 过程中,您使用Spring的支持将Tomcat servlet容器作为HTTP运行时嵌入,而不是部署到外部实例。

src/main/java/hello/Application.java

package hello;

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是一个方便的注释,它增加了以下所有内容:

main()方法使用Spring Boot的SpringApplication.run()方法启动应用程序。 你有没有注意到没有一行XML? 没有web.xml文件。 这个Web应用程序是100%纯Java,您不必处理配置任何管道或基础设施。

构建一个可执行的JAR

您可以使用Gradle或Maven从命令行运行应用程序。 或者您可以构建一个包含所有必需的依赖项,类和资源的可执行JAR文件,并运行该文件。 这使得在整个开发生命周期内跨越不同环境等,将服务作为应用程序发布,版本化和部署变得非常容易。

如果您正在使用Gradle,则可以使用./gradlew bootRun运行该应用程序。 或者您可以使用./gradlew build JAR文件。 然后你可以运行JAR文件:

  java -jar build / libs / gs-rest-service-0.1.0.jar 

如果您使用的是Maven,则可以使用./mvnw spring-boot:run来运行该应用程序。 或者,您可以使用./mvnw clean package构建JAR文件。 然后你可以运行JAR文件:

  java -jar target / gs-rest-service-0.1.0.jar 

上述过程将创建一个可运行的JAR。 您也可以选择构建经典的WAR文件

记录输出显示。 该服务应该在几秒钟内启动并运行。

测试服务

现在服务已启动,请访问http://localhost:8080/greeting ,您会看到:

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

使用http://localhost:8080/greeting?name=User,提供name的字符串参数。 请注意content属性的值是如何从“Hello,World!”更改的 到“Hello User!”:

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

此更改演示了GreetingController中的@RequestParam按预期工作。 name参数已被赋予默认值“World”,但始终可以通过传入字符串显式覆盖。

还要注意id属性如何从1更改为2 。 这证明您正在使用相同GreetingController实例处理多个请求,并且按照预期,在每次调用中其counter字段正在递增。

总结

恭喜! 您刚刚用Spring开发了一个RESTful Web服务。

也可以看看

以下指南也可能有所帮助:

想写一个新的指南或贡献一个现有的? 查看我们的贡献指南

所有指南均附带代码的ASLv2许可证,以及用于撰写的归属,NoDerivatives创意公共许可证


原文链接:Building a RESTful Web Service