使用 Spring Boot 构建一个REST风格的Web服务

心已赠人 2022-05-24 12:36 315阅读 0赞

**目录：**

### 文章目录 ###

*   *  一 你将实现如下的效果
     *  二 一个REST风格的Web服务实例
     *   *  2.1 添加Maven依赖
         *  2.2 项目结构
         *  2.3 创建实体类：
         *  2.4 创建Controller类：
         *  2.5 创建服务启动类：
         *  2.6 运行测试
         *  参考教程：

该节主要是对官方一个例子的补充。官方的这个例子很不错，所以这里分享给大家。

## 一 你将实现如下的效果 ##

**不带参数的访问：**

http://localhost:8080/greeting

浏览器会返回一个表示对象的JSON格式的数据

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

**带参数的访问：**

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

浏览器会返回一个表示对象的JSON格式的数据

{ "id":4,"content":"Hello, Snailclimb!"}

![浏览器会返回一个表示对象的JSON格式的数据][JSON]

## 二 一个REST风格的Web服务实例 ##

我这里就不再讲述项目的创建过程了，不了解的可以看第一篇文章。

### 2.1 添加Maven依赖 ###

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>org.springframework</groupId>
        <artifactId>gs-rest-service</artifactId>
        <version>0.1.0</version>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.2.RELEASE</version>
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>com.jayway.jsonpath</groupId>
                <artifactId>json-path</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-surefire-plugin</artifactId>
                    <configuration>
                        <skip>true</skip>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    
    </project>

### 2.2 项目结构 ###

**项目结构：**

└── src
        └── main
            └── java
                └── SpringBootWebService

### 2.3 创建实体类： ###

src/main/java/SpringBootWebService/Greeting .java

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

### 2.4 创建Controller类： ###

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

src/main/java/SpringBootWebService/GreetingController .java

package SpringBootWebService;
    
    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（）方法。这个在Spring中经常用，相比大家都应该知道。我们上面的例子没有指定GET与PUT，POST等等，因为 **@RequestMapping默认映射所有的HTTP操作** 。 如果我们想指定某几种请求方式的话，可以使用 **@RequestMapping（method = GET）** 来缩小这个映射。

**@RequestParam** 将查询字符串参数名称的值绑定到greeting（）方法的name参数中。 如果请求中缺少name参数，则使用“World”的defaultValue。

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

**@RestController:** 此代码使用Spring 4的新的@RestController注释，该注释将类标记为控制器，其中每个方法都返回一个域对象而不是视图。 它是@Controller和@ResponseBody的缩写。我们上一节也介绍到了。

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

### 2.5 创建服务启动类： ###

虽然可以将此服务作为传统WAR文件打包以部署到外部应用程序服务器，但下面演示的更简单的方法会创建独立应用程序。 **您可以将所有内容打包到一个单独的，可执行的JAR文件中，然后可以通过直接运行main方法的形式启动，就像之前我们运行普通的j2se程序一样。** 在使用Spring Boot的过程中，我们可以使用Spring的支持将Tomcat servlet容器作为HTTP运行时嵌入，而不是部署到外部实例。

src/main/java/SpringBootWebService/Application .java

package SpringBootWebService;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class Application { 
    
        public static void main(String[] args) { 
             //启动应用程序，不需要一行xml配置，真的很赞啊！！！纯100%的Java了解一下~~~
            SpringApplication.run(Application.class, args);
        }
    }

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

*  **@Configuration：** 将类标记为应用程序上下文的bean定义的来源。
 *  **@EnableAutoConfiguration:** 让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置。
 *  通常你会为Spring MVC应用程序添加@EnableWebMvc，但Spring Boot在类路径中看到spring-webmvc时会自动添加。 这将该应用程序标记为Web应用程序并激活关键行为，例如设置DispatcherServlet。
 *  **@ComponentScan：** 告诉Spring在hello包中查找其他组件，配置和服务，以便找到控制器。

### 2.6 运行测试 ###

我们上一节已经知道了通过运行main方法的形式启动项目，现在我们介绍另外一种方法。

**通过java -jar的方式运行程序：**

（1） 在项目目录运行mvn install命令

mvn install

补充：mvn clean 命令用于清除产生的项目

idea用于可以直接在Terminal下输入相关命令  
![在项目目录运行mvn install命令][mvn install]  
（2）完成之后target会多出一个jar包  
进入target目录：

cd target

通过java -jar的方式运行：

java -jar helloworld-0.0.1-SNAPSHOT.jar

停止程序：

ctrl+c

> **可能遇到的问题：**

Tests run: 1, Failures: 0, Errors: 1, Skipped: 0, Time elapsed: 0.411 s <<< FAILURE! - in com.example.demo.DemoApplicationTests
    initializationError(com.example.demo.DemoApplicationTests)  Time elapsed: 0.005 s  <<< ERROR!
    java.lang.IllegalStateException: Unable to find a @SpringBootConfiguration, you need to use @ContextConfiguration or @SpringBootTest(classes=...) with your test

**解决办法：**  
pom.xml文件中添加下列配置：

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <configuration>
         <skip>true</skip>
        </configuration>
       </plugin>

### 参考教程： ###

对应官方文档教程：[https://spring.io/guides/gs/rest-service/][https_spring.io_guides_gs_rest-service]

[JSON]: /images/20220524/65f078f6dfa842c0864c07a77950dd5b.png
[mvn install]: /images/20220524/1ada6e8defd6456e910d1896ca94a04b.png
[https_spring.io_guides_gs_rest-service]: https://spring.io/guides/gs/rest-service/