在學(xué)習(xí)HelloWorld之后,我們來嘗試構(gòu)建一個(gè)RESTful工程赶站。
- 什么是REST?
首先绰上,REST是Web自身的架構(gòu)風(fēng)格泡垃。REST也是Web之所以取得成功的技術(shù)架構(gòu)方面因素的總結(jié)。REST是世界上最成功的分布式應(yīng)用架構(gòu)風(fēng)格(成功案例:Web羡鸥,還不夠嗎蔑穴?)。它是為 運(yùn)行在互聯(lián)網(wǎng)環(huán)境 的 分布式 超媒體系統(tǒng)量身定制的惧浴〈婧停互聯(lián)網(wǎng)環(huán)境與企業(yè)內(nèi)網(wǎng)環(huán)境有非常大的差別,最主要的差別是兩個(gè)方面:
可伸縮性需求無法控制:并發(fā)訪問量可能會暴漲衷旅,也可能會暴跌捐腿。
安全性需求無法控制:無法控制客戶端發(fā)來的請求的格式,很可能會是惡意的請求柿顶。
而所謂的“超媒體系統(tǒng)”茄袖,即,使用了超文本的系統(tǒng)嘁锯∠芟椋可以把“超媒體”理解為超文本+媒體內(nèi)容。
REST是HTTP/1.1協(xié)議等Web規(guī)范的設(shè)計(jì)指導(dǎo)原則家乘,HTTP/1.1協(xié)議正是為實(shí)現(xiàn)REST風(fēng)格的架構(gòu)而設(shè)計(jì)的蝗羊。新的Web規(guī)范,其設(shè)計(jì)必須符合REST的要求仁锯,否則整個(gè)Web的體系架構(gòu)會因?yàn)橐雵?yán)重矛盾而崩潰耀找。這句話不是危言聳聽,做個(gè)類比业崖,假如蘇州市政府同意在市區(qū)著名園林的附近大型土木野芒,建造大量具有后現(xiàn)代風(fēng)格的摩天大樓,那么不久之后世界聞名的蘇州園林美景將不復(fù)存在腻要。
上述這些關(guān)于“REST是什么”的描述复罐,可以總結(jié)為一句話:REST是所有Web應(yīng)用都應(yīng)該遵守的架構(gòu)設(shè)計(jì)指導(dǎo)原則。當(dāng)然雄家,REST并不是法律效诅,違反了REST的指導(dǎo)原則,仍然能夠?qū)崿F(xiàn)應(yīng)用的功能趟济。但是違反了REST的指導(dǎo)原則乱投,會付出很多代價(jià),特別是對于大流量的網(wǎng)站而言顷编。
- REST的關(guān)鍵詞
- 資源(Resource)
- 資源的表述(Representation)
- 狀態(tài)轉(zhuǎn)移(State Transfer)
- 統(tǒng)一接口(Uniform Interface)
- 超文本驅(qū)動(Hypertext Driven)
- REST的特征
- 面向資源(Resource Oriented)
- 可尋址(Addressability)
- 連通性(Connectedness)
- 無狀態(tài)(Statelessness)
- 統(tǒng)一接口(Uniform Interface)
- 超文本驅(qū)動(Hypertext Driven)
更多可以參考:理解本真的REST架構(gòu)風(fēng)格
-
開始創(chuàng)建RESTful工程
我們依舊使用IDEA作為開發(fā)工具戚炫,首先依舊是新建一個(gè)SpringInitializr項(xiàng)目,這里和前面的HelloWorld程序一樣媳纬,但是在勾選Dependensencise時(shí)需要額外勾上MySQL和MyBaties.
勾選Dependensencise - 創(chuàng)建數(shù)據(jù)庫
DROP TABLE IF EXISTS city
;
CREATE TABLE city
(
id
int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT '城市編號',
province_id
int(10) unsigned NOT NULL COMMENT '省份編號',
city_name
varchar(25) DEFAULT NULL COMMENT '城市名稱',
description
varchar(25) DEFAULT NULL COMMENT '描述',
PRIMARY KEY (id
)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;
+ 創(chuàng)建工程目錄如下
![創(chuàng)建工程目錄](http://upload-images.jianshu.io/upload_images/3189042-5351ab0a233aa154.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
Controller包里存放控制器:
```java
package org.vzard.springboot.controller;
import jdk.nashorn.internal.ir.RuntimeNode;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.vzard.springboot.domain.City;
import org.vzard.springboot.service.CityService;
import java.util.List;
/**
* Created by V-zar on 2017/7/2.
*/
@RestController
public class CityRestController {
@Autowired
private CityService cityService;
@RequestMapping(value = "/vzard/city/{id}",method = RequestMethod.GET)
public City findOneCity(@PathVariable Long id){
return cityService.findCityById(id);
}
@RequestMapping(value = "/vzard/city",method = RequestMethod.GET)
public List<City> findAllCity(){
return cityService.findAllCity();
}
@RequestMapping(value = "/vzard/city",method = RequestMethod.POST)
public void createCity(@RequestBody City city){
cityService.saveCity(city);
}
@RequestMapping(value = "/vzard/city",method = RequestMethod.PUT)
public void modifyCity(@RequestBody City city){
cityService.updateCity(city);
}
@RequestMapping(value = "/vzard/city/{id}",method = RequestMethod.DELETE)
public void modifyCity(@PathVariable("id") Long id){
cityService.deleteCity(id);
}
}
dao包存放接口類:
package org.vzard.springboot.dao;
import org.apache.ibatis.annotations.Param;
import org.vzard.springboot.domain.City;
import java.util.List;
/**
* 城市DAO接口類
*
* Created by V-zar on 2017/7/2.
*/
public interface CityDao {
/**
* 獲取城市信息列表
* @return
*/
List<City> findAllCity();
/**
* 根據(jù)id獲取城市信息
* @param id
* @return
*/
City findById(@Param("id") Long id);
/**
* 保存城市信息
* @param city
* @return
*/
Long saveCity(City city);
/**
* 更新城市信息
* @param city
* @return
*/
Long updateCity(City city);
/**
* 刪除城市信息
* @param id
* @return
*/
Long deleteCity(Long id);
}
domain包存放實(shí)體類
package org.vzard.springboot.domain;
/**
* 城市實(shí)體類
*
* Created by V-zar on 2017/7/2.
*/
public class City {
/**
* 城市id
*/
private Long id;
/**
* 省份id
*/
private Long provinceId;
/**
* 城市名稱
*/
private String cityName;
/**
* 描述
*/
private String description;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public Long getProvinceId() {
return provinceId;
}
public void setProvinceId(Long provinceId) {
this.provinceId = provinceId;
}
public String getCityName() {
return cityName;
}
public void setCityName(String cityName) {
this.cityName = cityName;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
}
service包里存放服務(wù)接口及其實(shí)現(xiàn)
package org.vzard.springboot.service;
import org.vzard.springboot.domain.City;
import java.util.List;
/**
* 城市業(yè)務(wù)邏輯接口
*
* Created by V-zar on 2017/7/2.
*/
public interface CityService {
/**
* 獲取城市列表
* @return
*/
List<City> findAllCity();
/**
* 根據(jù)城市id尋找城市
* @param id
* @return
*/
City findCityById(Long id);
/**
* 保存城市信息
* @param city
* @return
*/
Long saveCity(City city);
/**
* 更新城市信息
* @param city
* @return
*/
Long updateCity(City city);
/**
* 刪除城市信息
* @param id
* @return
*/
Long deleteCity(Long id);
}
package org.vzard.springboot.service.impl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.vzard.springboot.dao.CityDao;
import org.vzard.springboot.domain.City;
import org.vzard.springboot.service.CityService;
import java.util.List;
/**
* Created by V-zar on 2017/7/2.
*/
@Service
public class CityServiceImpl implements CityService{
@Autowired
private CityDao cityDao;
@Override
public List<City> findAllCity() {
return cityDao.findAllCity();
}
@Override
public City findCityById(Long id) {
return cityDao.findById(id);
}
@Override
public Long saveCity(City city) {
return cityDao.saveCity(city);
}
@Override
public Long updateCity(City city) {
return cityDao.updateCity(city);
}
@Override
public Long deleteCity(Long id) {
return cityDao.deleteCity(id);
}
}
程序入口類
package org.vzard.springboot;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("org.vzard.springboot.dao")
public class SpringbootApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootApplication.class, args);
}
}
數(shù)據(jù)源&MyBaties&端口配置
#數(shù)據(jù)源配置
spring.datasource.url=jdbc:mysql://localhost:3306/springbootdb?useUnicode=true&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=5432
spring.datasource.dbcp2.driver-class-name=com.mysql.jdbc.Driver
#Mybatis 配置
mybatis.typeAliasesPackage=org.vzard.springboot.domain
mybatis.mapperLocations=classpath:mapper/*.xml
#配置端口
server.port=${port:8009}
Mybaties映射文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="org.vzard.springboot.dao.CityDao">
<resultMap id="BaseResultMap" type="org.vzard.springboot.domain.City">
<result column="id" property="id" />
<result column="province_id" property="provinceId" />
<result column="city_name" property="cityName" />
<result column="description" property="description" />
</resultMap>
<parameterMap id="City" type="org.vzard.springboot.domain.City"/>
<sql id="Base_Column_List">
id, province_id, city_name, description
</sql>
<select id="findById" resultMap="BaseResultMap" parameterType="java.lang.Long">
select
<include refid="Base_Column_List" />
from city
where id = #{id}
</select>
<select id="findAllCity" resultMap="BaseResultMap" >
select
<include refid="Base_Column_List" />
from city
</select>
<insert id="saveCity" parameterMap="City" useGeneratedKeys="true" keyProperty="id">
insert into
city(id,province_id,city_name,description)
values
(#{id},#{provinceId},#{cityName},#{description})
</insert>
<update id="updateCity" parameterMap="City">
update
city
set
<if test="provinceId!=null">
province_id = #{provinceId},
</if>
<if test="cityName!=null">
city_name = #{cityName},
</if>
<if test="description!=null">
description = #{description}
</if>
where
id = #{id}
</update>
<delete id="deleteCity" parameterType="java.lang.Long">
delete from
city
where
id = #{id}
</delete>
</mapper>
到此工程創(chuàng)建完畢運(yùn)行程序入口類啟動項(xiàng)目:
-
插入記錄双肤,URL:http://127.0.0.1:8009/vzard/city
插入記錄 -
更改記錄施掏,URL:http://127.0.0.1:8009/vzard/city
更改記錄 -
刪除記錄,URL:http://127.0.0.1:8009/vzard/city/2
刪除記錄 -
查詢記錄
查詢記錄
表單提交的測試工具為Chrome的插件PostMan,很強(qiáng)大
demo