spring boot 从零开始入门2: REST服务通过对象返回JSON

如果您认为对你有帮助,请点个赞!

概述

在上一篇环境搭建及HelloWorld,我们搭建了spring boot开发环境,并开发了第一个web应用HelloWorld。

本篇将在WEB服务中,通过对象返回JSON格式的字符串。

在没有spring boot时,通常使用如下方法来实现:

  • 使用JSONObject、JSONArray对象来构建JSON对象(虽然学习比较简单,但代码量很大)
  • 或使用 jackson实现对象与JSON的映射 (首次使用jackjon时,各种查资料,花了数天时间)

无论使用哪种方法,我们都需要添加依赖包(那怕是通过maven,也需要在pom配置文件中添加依赖引用),还需要编写不少代码。使用spring boot时,我们只需要编写对象本身的代码,转换成JSON不需要编写一行代码(零代码)

下面就让我们来见证奇迹吧,进入实战环节。

实战

在实现中我们将完成如下步骤:

  • 创建一个用户类(User.java ) ,该类包含Id、Name属性。
  • 创建一个User对象,并以JSON格式返回
准备工作

在开始实战前,需要准备好开发环境,并创建一个WEB项目。
具体请参见上一篇环境搭建及HelloWorld

新建User.java类

新建一个用户类 User.java ,具体代码如下:

//User.java

package com.example.helloworld;

import java.util.Date;

public class User {
    private int id;
    private String name;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}
创建服务,将User对象以JSON返回

新建一个类 UserController.java ,具体代码如下:

//UserController.java

package com.example.helloworld;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {
    @RequestMapping("/get")         //url
    public User getUser() {         //直接返回User对象
        User user = new User();
        user.setId(1);
        user.setName("Jack");
        return user;
    }
}
运行项目

在”HelloworldApplication.java“文件上右键,点击run 菜单项,即可启动WEB服务

通过浏览器来访问该应用,在浏览器地址栏输入: http://localhost:8080/get
结果如下图所示:

image.png

阶段小结

我们没有编写一行关于JSON的代码,也没有进行任何配置。
这就是spring boot可以简化开发,是不是很神奇。

复杂对象

首先我们增加一个地址类UserAddress.java,代码如下:

//UserAddress.java

package com.example.helloworld;

public class UserAddress {
    private String zip; //邮政编码
    private String address; //地址

    public UserAddress(String zip, String address) {
        this.zip = zip;
        this.address = address;
    }

    public String getZip() {
        return zip;
    }

    public void setZip(String zip) {
        this.zip = zip;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }
}

然后修改User.java ,在该类中增加地址类,增加的代码如下

    private UserAddress userAddress;

    public UserAddress getUserAddress() {
        return userAddress;
    }

    public void setUserAddress(UserAddress userAddress) {
        this.userAddress = userAddress;
    }

最后在 UserController的getUser()方法中,增加如下代码

user.setUserAddress(new UserAddress("400000","重庆市"));

运行结果如下图:

{"id":1,"name":"Jack","userAddress":{"zip":"400000","address":"重庆市"}}

数组示例

//User.java 在该类中增加如下语句
   private String[] hobbys;

   public String[] getHobbys() {
       return hobbys;
   }

   public void setHobbys(String[] hobbys) {
       this.hobbys = hobbys;
   }
//UserController.java        在getUser()方法中增加如下语句
 user.setHobbys(new String[]{"游泳","计算机","篮球"});

运行结果如下:

{"id":1,"name":"Jack","userAddress":{"zip":"400000","address":"重庆市"},"hobbys":["游泳","计算机","篮球"]}

MAP对象示例

//UserController.java  在该类中增加如下两个方法
    @RequestMapping("/map")
    public Map<String, User> getUsers() {
        Map<String, User> map = new LinkedHashMap<>();
        User user1 = createUser(1, "Jack", new String[]{"游泳", "计算机", "篮球"});
        map.put("user1",user1);

        User user2 = createUser(2, "ZhangK", new String[]{"计算机", "爬山", "涉水", "开飞机"});
        map.put("user2",user2);

        return map;
    }

    private User createUser(int id, String name, String[] hobbys) {
        User user = new User();
        user.setId(id);
        user.setName(name);
        user.setUserAddress(new UserAddress("400000", "重庆市"));
        user.setHobbys(hobbys);
        return user;
    }

运行结果如下:
注意访问url最后的路径需要修改一下: http://localhost:8080/map

{"user1":{"id":1,"name":"Jack","userAddress":{"zip":"400000","address":"重庆市"},"hobbys":["游泳","计算机","篮球"]},
"user2":{"id":2,"name":"ZhangK","userAddress":{"zip":"400000","address":"重庆市"},"hobbys":["计算机","爬山","涉水","开飞机"]}}

下一篇 spring boot 从零开始入门3: 读取属性配置文件

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