[Spring-boot] No.1 做一个RESTful风格的Web服务

一、目标 (Goal):

我们将要编写一个接收HTTP GET 请求的后台服务,如下:
http://localhost:8080/greeting
以及返回一个JSON格式的“问候”:
{"id":1,"content":"Hello, World!"}
并且我们可以带着一个参数(name)请求:
http://localhost:8080/greeting?name=Boy
然后我们将得到 "Hello, Boy!"的“问候”:
{"id":1,"content":"Hello, User!"}
以上就是我们本次所要做的全部内容,Let's start it!

二、工具

  • IDE:我使用的是Intellij IDEA 2016.1.3;Eclipse也很不错;
  • JDK 1.8 及以后
  • Maven 3.0+ (或者Gradle 2.3);
  • 也可以从 https://start.spring.io/ 直接自定义一个spring-boot工程文件并下载使用;注意Dependencies处需要添加Web依赖,其他等以后用到可以另作添加;

三、Coding

先看一下我们需要返回的数据格式(JSON):

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

那么为了与之对应,我们就先编写一个Greeting类:
路径:src/main/java/com/fd/restService/model/Greeting.java

package com.fd.restService.model;

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形式。

接下来创建一个控制器(Controller):

在Spring应用中,HTTP请求将由控制器(Controller)接收,并进行相应处理。@RestController将GreetingController类标注为一个控制器。

路径:src/main/java/com/fd/restService/controller/GreetingController.java

package com.fd.restService.controller;

import com.fd.demo.model.Greeting;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.concurrent.atomic.AtomicLong;

@RestController    //标注为控制器
public class GreetingController {

    private static final String template = "Hello, %s!";     //返回格式
    private final AtomicLong counter = new AtomicLong();  //线程安全的Long

    @RequestMapping("/greeting")   //设置访问路径
    //设置一个请求参数name,不传则默认传“World”字符串
    public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) {   
        //简单的返回一个Greeting实例,而Spring会将其转化为JSON格式
        return new Greeting(counter.incrementAndGet(), String.format(template, name));    
    }
}

注意几个注解的用法:

  • @RestController:包含了@Controller和@ResponseBody;
  • @RequestMapping:value属性表示访问路径设置,method属性设置HTTP方法(如GET、POST、PUT等);
    如:@RequestMapping(value = "/greeting",method = RequestMethod.GET)
  • @RequestParam:常用有value、defaultValue、required属性等

注:与传统的MVC(通常返回一个HTML视图)不同,RESTful风格的Web服务注重数据的交互,所以在返回的HTTP消息体中只有简单的数据本地(JSON格式简洁且易理解),这样也便利了前后端的分离。

运行前的工作:

在通常的工作中,我们都是通过打包成war包然后部署到远程服务器上的这么一个步骤。而spring有一套更简便运行web服务的策略:

将所有需要运行的类都各自打包成一个独立的jar包,并设置一个main()函数作为程序入口。然后就可以通过spring的内置Tomcat容器部署运行你的服务。

以上都是策略,不需要我们实际依次去操作。
我们只要提供一个程序入口类:
路径:src/main/java/com/fd/restService/ResTfulServiceApplication.java

package com.fd.restService;

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

@SpringBootApplication
public class ResTfulServiceApplication {

    public static void main(String[] args) {
        SpringApplication.run(ResTfulServiceApplication.class, args);
    }
}
  • @SpringBootApplication注解是以下几个注解的总和:
    1.@Configuration:它告知 Spring 容器这个类是一个拥有 bean 定义和依赖项的配置类;
    2.@EnableAutoConfiguration:暗地里定义了一个基础的包路径,Spring Boot会在该包路径来搜索类;
    3.@EnableWebMvc
    4.@ComponentScan:让Spring去寻找包内其他的组件、配置以及服务,在这里也就是找到我们的GreetingController 类;

最后,打jar包运行或者依赖IDE运行后:


Intellij IDEA 运行方式
日志信息

运行成功后在浏览器中输入:
http://localhost:8080/greeting
得到返回结果:
{"id":1,"content":"Hello, World!"}

参考文档

https://spring.io/guides/gs/rest-service/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 207,113评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,644评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,340评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,449评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,445评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,166评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,442评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,105评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,601评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,066评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,161评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,792评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,351评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,352评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,584评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,618评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,916评论 2 344

推荐阅读更多精彩内容