Spring Boot 构建一个 RESTful Web Service

2018-04-12 15:23 Spring.Guo 阅读(1306) 评论(0) 编辑收藏举报

1 项目目标：

构建一个 web service，接收get 请求

http://localhost:8080/greeting

响应一个json 结果：

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

可以在请求中添加自定义参数name

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

响应结果：

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

2 环境准备：

 1） 开发工具 IntelliJ IDEA  （自己下载安装） cdkey 网上找吧。

 2） JAVA JDK1.8+   （http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html）   //  本示例是用的 jdk1.8.0_172   Windows x64

    2).1  配置 JDK 环境变量。 http://www.cnblogs.com/iampkm/p/8805493.html

          根据JDK 的安装路径，在系统环境变量中配置 （JAVA_HOME,PATH,CLASSPATH）

 3） 配置Maven 3.2+   下载：https://maven.apache.org/download.cgi  （我用的是3.5）

   3）.1 新建本地库目录repository （位置可以随意）。我是在apache-maven-3.5.2 目录下 创建的。

3) .2 settings.xml 中配置本地库。打开maven 目录下的 conf/settings.xml 文件，修改自己的库目录

3）.3 settings.xml 中修改maven镜像下载地址为淘宝,在配置文件中，加入红色代码部分

<mirrors>
    
    <mirror>
    <id>alimaven</id>
    <name>aliyun maven</name>
    <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
    <mirrorOf>central</mirrorOf>
    </mirror>
</mirrors>

3) .4在idea 中，把maven 改成本地位置。打开Idea ，选择File > Settings > 按照如下图配置本地maven 的三个位置即可。

3 新建项目greeting。启用spring boot 初始化

输入项目名，我本地取名 quickstart

选择web

创建一个资源 java 类 model

Create a resource representation class

Now that you’ve set up the project and build system, you can create your web service.

Begin the process by thinking about service interactions.

The service will handle GET requests for /greeting, optionally with a name parameter in the query string. The GET request should return a 200 OK response with JSON in the body that represents a greeting. It should look something like this:

package com.example.qucikstart;

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

这个就是返回的结果内：该类在返回时，会自动被转换成json格式

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

创建一个java 控制类 GreetingController

Create a resource controller

In Spring’s approach to building RESTful web services, HTTP requests are handled by a controller. These components are easily identified by the @RestController annotation, and the GreetingController below handles GET requests for /greeting by returning a new instance of the Greeting class:

package com.example.qucikstart;

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

This controller is concise and simple, but there’s plenty going on under the hood. Let’s break it down step by step.

The @RequestMapping annotation ensures that HTTP requests to /greeting are mapped to the greeting() method.

当请求 RequestMapping 注解会把 greeting 的请求，映射到 greeting 方法。

确保main 程序用springboot 启动

Make the application executable

Although it is possible to package this service as a traditional WAR file for deployment to an external application server, the simpler approach demonstrated below creates a standalone application. You package everything in a single, executable JAR file, driven by a good old Java main() method. Along the way, you use Spring’s support for embedding the Tomcat servlet container as the HTTP runtime, instead of deploying to an external instance.

package com.example.qucikstart;

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

@SpringBootApplication
public class QucikstartApplication {

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

项目结构：