Spring Boot 创建RESTful Web Service

最新推荐文章于 2024-04-05 09:31:14 发布

Sommer_Xia

最新推荐文章于 2024-04-05 09:31:14 发布

阅读量2.1k

点赞数

分类专栏： Spring FrameWork 文章标签： spring framework maven springboot

Spring FrameWork 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

1. 介绍

本篇将使用Spring Boot创建一个简单restful风格web服务，接受HTTP GET请求：

http://localhost:8080/greeting

响应体（respond）为一个JSON字符串

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

2. 环境要求

IED 或文本编辑器

JDK1.8+

Maven 3.0+

3. 项目工程

1) pom.xml

<?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>1.4.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>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-releases</id>
            <url>https://repo.spring.io/libs-release</url>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-releases</id>
            <url>https://repo.spring.io/libs-release</url>
        </pluginRepository>
    </pluginRepositories>
</project>

Spring Boot Maven Plugin 的作用为：

将本项目classpath里面的所有jar包打包成一个可执行的jar文件；

找到包含public static void main() 方法的类，作为可执行jar的入口

提供內建的依赖分析器，为Spring boot dependencies设置默认的版本号（可以被自己指定的版本号覆盖）

2) 创建资源表示类（resource representation，即RESTful中的R，简单理解就是实体）

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库将实体类的对象自动转换成JSON。

3) 资源控制类

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

控制器代码很简洁，但是却做了很多事情。

@RestController将该类标注为一个spring bean，并标记其中的每个方法返回一个实体对象。相当于@Controller+@ResponsBody。

@RequestMapping提供url和方法的映射，当接收到一个/greeting的请求时，能执行greeting()方法。

注：上面的例子没有指定http动作(GET, PUT, POST, DELETE)，所以会与所有的动作匹配。更好的方法是使用@RequestMapping(method=GET)，这样只会接收到GET请求。

@RequestParam通过指定的value绑定url中的参数。本例中，url参数是可选的，因为提供了默认值“World”。

方法体创建Greeting()对象并返回。

注：传统的MVC 控制器和RESTful 控制器的区别在于http响应是怎样被创建的。

传统的MVC 控制器会通过视图转换将Greeting对象渲染成html返回到前端。

而RESTful 控制器直接返回Greeting对象，通过JSON转换器变成一个JSON字符串。

4) 执行类

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 = @Configuration+@EnableAutoConfiguration+@ComponentScan

@Configuration将该类标注为一个spring bean

@EnableAutoConfiguration告诉Spring Boot装载bean的方式可以基于classpath设置、其他bean或属性设置。

正常情况下我们会为Spring MCV应用加上@EnableWebMvc，但是这里Spring Boot已经为我们做好了，它检测到了工程classpath下有spring-mvc jar，就会自动加上这个注解来激活web应用的关键动作，如创建DispatcherServlet。

@ComponentScan 扫描当前包里面所有带@Component、@Service、@Controller等注解的类，加入spring容器注册成bean。

main方法里用Spring Boot的SpringApplication.run()方法启动web应用。整个项目没有一个xml配置文件，包括web.xml，这就是Spring Boot的强大所在，让用户只关注业务逻辑的java代码，不用去处理项目配置和结构。

5) 构建可执行JAR

命令行进入项目根目录

输入./mvnw spring-boot:run

或./mvnw clean package

会发现项目目录下生成一个target文件夹，里面的jar文件即为可执行JAR。

运行JAR java -jar target/gs-rest-service-0.1.0.jar