【微服务架构】-【接口设计】

这五大类总共包含100多种状态码，覆盖了绝大部分可能遇到的情况。每一种状态码都有标准的（或者约定的）解释，客户端只需查看状态码，就可以判断出发生了什么情况，所以服务器应该返回尽可能精确的状态码。

数据传输格式

请求与响应都为JSON格式

服务器响应时 API 返回的数据格式，不应该是纯文本，而应该是一个 JSON 对象，因为这样才能返回标准的结构化数据。所以，服务器响应的 HTTP 头的-Type属性要设为/json。

客户端请求时，也要明确告诉服务器，可以接受 JSON 格式，即请求的 HTTP 头的属性也要设成/json。

问题场景说明：

整理下项目接口风格代码的编写流程。

博客目录

一、开发准备

二、工程说明

三、代码编写

四、代码测试

一、开发准备

在开发程序之前，应先做好一下准备

1.1 数据库和表

CREATE DATABASE `spring-boot-case`;
USE `spring-boot-case`;
DROP TABLE IF EXISTS `t_user`;
CREATE TABLE `t_user` (`id` int(11) NOT NULL AUTO_INCREMENT COMMENT 'id',`name` varchar(10) DEFAULT NULL COMMENT '姓名',`age` int(2) DEFAULT NULL COMMENT '年龄',PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=12 DEFAULT CHARSET=utf8;

1.2 maven相关依赖

最核心的jar

-boot- ：核心模块，包括自动配置支持、日志和YAML；

<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"><parent><groupId>org.springframework.bootgroupId><artifactId>spring-boot-starter-parentartifactId><version>2.1.0.RELEASEversion><relativePath/> parent><modelVersion>4.0.0modelVersion><artifactId>spring-boot-restful-crudartifactId><properties><project.build.sourceEncoding>UTF-8project.build.sourceEncoding><java.version>1.8java.version><mybatis-spring-boot>1.3.2mybatis-spring-boot><mysql-connector>8.0.16mysql-connector>properties><dependencies><dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-starter-webartifactId>dependency><dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-starter-thymeleafartifactId>dependency><dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-starter-data-jpaartifactId>dependency><dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-devtoolsartifactId><optional>trueoptional>dependency><dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-starter-testartifactId><scope>testscope>dependency><dependency><groupId>org.mybatis.spring.bootgroupId><artifactId>mybatis-spring-boot-starterartifactId><version>${mybatis-spring-boot}version>dependency><dependency><groupId>mysqlgroupId><artifactId>mysql-connector-javaartifactId><version>${mysql-connector}version>dependency>dependencies><build><plugins><plugin><groupId>org.springframework.bootgroupId><artifactId>spring-boot-maven-pluginartifactId><configuration><fork>truefork>configuration>plugin>plugins>build>project>

2.2 自定义配置文件

一般我们需要一些自定义的配置，例如配置jdbc的连接配置，在这里我们可以用 . 进行配置。数据源实际的配置以各位的为准。

## 数据源配置
spring.datasource.url=jdbc:mysql://localhost:3307/spring-boot-case?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
## Mybatis 配置
# 配置为 com.dk.bean 指向实体类包路径。
mybatis.typeAliasesPackage=com.dk.bean
# 配置为 classpath 路径下 mapper 包下，* 代表会扫描所有 xml 文件。
mybatis.mapperLocations=classpath\:mapper/*.xml

二、工程说明

2.1工程结构图:

com.dk.web - 层

com.dk.dao - 数据操作层 DAO

com.dk.bean - 实体类

com.dk.bean. - 业务逻辑层

- 应用启动类

. - 应用配置文件，应用启动会自动读取配置

2.2 自定义配置文件

一般我们需要一些自定义的配置，例如配置jdbc的连接配置，在这里我们可以用 . 进行配置。数据源实际的配置以各位的为准。

## 数据源配置
spring.datasource.url=jdbc:mysql://localhost:3307/spring-boot-case?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
## Mybatis 配置
# 配置为 com.dk.bean 指向实体类包路径。
mybatis.typeAliasesPackage=com.dk.bean
# 配置为 classpath 路径下 mapper 包下，* 代表会扫描所有 xml 文件。
mybatis.mapperLocations=classpath\:mapper/*.xml

三、代码编写

3.1 Pojo类User的编写

来到重点的代码这快了。

我们开始先编写pojo类，对应数据库中的表。

代码如下

package com.dk.bean;/*** @Description: TODO* @Author Cheri* @Date 2019/8/4 - 17:11* @Version V1.0**/
public class User {/** 编号 */private int id;/** 姓名 */private String name;/** 年龄 */private int age;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;}public int getAge() {return age;}public void setAge(int age) {this.age = age;}
}

3.2 Dao层编写

在以前的Dao层这块，和 都可以使用注解或者使用配置文件。在这

里我们使用注解来完成CRUD。

说明:

一般有两种方式实现与数据库实现CRUD：

第一种是xml的配置。

第二种是使用注解，@、@、@、@ 这些来完成。本篇使用的是第

二种

package com.dk.dao;import com.dk.bean.User;
import org.apache.ibatis.annotations.*;
import org.springframework.data.repository.query.Param;import java.util.List;/*** @Description: TODO* @Author Cheri* @Date 2019/8/4 - 17:14* @Version V1.0**/
@Mapper
public interface UserDao {/*** 用户数据新增*/@Insert("insert into t_user(id,name,age) values (#{id},#{name},#{age})")void addUser(User user);/*** 用户数据修改*/@Update("update t_user set name=#{name},age=#{age} where id=#{id}")void updateUser(User user);/*** 用户数据删除*/@Delete("delete from t_user where id=#{id}")void deleteUser(int id);/*** 根据用户名称查询用户信息**/@Select("SELECT id,name,age FROM t_user")// 返回 Map 结果集@Results({@Result(property = "id", column = "id"),@Result(property = "name", column = "name"),@Result(property = "age", column = "age"),})User findByName(@Param("name") String userName);/*** 根据用户ID查询用户信息**/@Select("SELECT id,name,age FROM t_user")User findById(@Param("id") int userId);/*** 根据用户age查询用户信息列表*/@Select("SELECT id,name,age FROM t_user where age = #{userAge}")List<User> findByAge(int userAge);
}

这个接口使用的注解个人理解:

: 在接口上添加了这个注解表示这个接口是基于注解实现的CRUD。

: 返回的map结果集， 表示User类的字段， 表示对应数据库的字段。

Param:sql条件的字段。

、、、:对应数据库的增、查、改、删。

3.3 业务逻辑层

这块和、的基本一样。

代码如下：

接口

package com.dk.service;import com.dk.bean.User;import java.util.List;/*** @Description: TODO* @Author Cheri* @Date 2019/8/4 - 17:21* @Version V1.0**/
public interface UserService {/*** 新增用户* @param user* @return*/boolean addUser(User user);/*** 修改用户* @param user* @return*/boolean updateUser(User user);/*** 删除用户* @param id* @return*/boolean deleteUser(int id);/*** 根据用户名字查询用户信息* @param userName*/User findUserByName(String userName);/*** 根据用户ID查询用户信息* @param userId*/User findUserById(int userId);/*** 根据用户年龄查询用户信息* @param userAge*/List<User> findUserByAge(int userAge);
}

实现类

package com.dk.service.impl;import com.dk.bean.User;
import com.dk.dao.UserDao;
import com.dk.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;import java.util.List;/*** @Description: TODO* @Author Cheri* @Date 2019/8/4 - 17:23* @Version V1.0**/
@Service
public class UserServiceImpl implements UserService {@Autowiredprivate UserDao userDao;@Transactional@Overridepublic boolean addUser(User user) {boolean flag = false;try {userDao.addUser(user);flag = true;} catch (Exception e) {e.printStackTrace();}return flag;}@Transactional@Overridepublic boolean updateUser(User user) {boolean flag = false;try {userDao.updateUser(user);flag = true;} catch (Exception e) {e.printStackTrace();}return flag;}@Transactional@Overridepublic boolean deleteUser(int id) {boolean flag = false;try {userDao.deleteUser(id);flag = true;} catch (Exception e) {e.printStackTrace();}return flag;}@Overridepublic User findUserByName(String userName) {return userDao.findByName(userName);}@Overridepublic User findUserById(int userId) {return userDao.findById(userId);}@Overridepublic List<User> findUserByAge(int userAge) {return userDao.findByAge(userAge);}
}

3.4 控制层

控制层这块和很像，但是相比而言要简洁不少。

关于控制层的注解个人的理解如下:

：默认类中的方法都会以json的格式返回。

: 接口路径配置。

: 请求格式。

: 请求参数。

具体实现如下:

package com.dk.controller;import com.dk.bean.User;
import com.dk.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;import java.util.List;/*** @Description: TODO* @Author Cheri* @Date 2019/8/4 - 17:26* @Version V1.0**/
@RestController
@RequestMapping(value = "/api/user")
public class UserRestController {@Autowiredprivate UserService userService;@RequestMapping(value = "/addUser", method = RequestMethod.POST)public boolean addUser(@RequestBody User user) {System.out.println("开始新增...");return userService.addUser(user);}@RequestMapping(value = "/updateUser", method = RequestMethod.PUT)public boolean updateUser(User user) {System.out.println("开始更新...");return userService.updateUser(user);}@RequestMapping(value = "/deleteUser", method = RequestMethod.DELETE)public boolean delete(@RequestParam(value = "userName", required = true) int userId) {System.out.println("开始删除...");return userService.deleteUser(userId);}@RequestMapping(value = "/userName", method = RequestMethod.GET)public User findByUserName(@RequestParam(value = "userName", required = true) String userName) {System.out.println("开始查询...");return userService.findUserByName(userName);}@RequestMapping(value = "/userId", method = RequestMethod.GET)public User findByUserId(@RequestParam(value = "userId", required = true) int userId) {System.out.println("开始查询...");return userService.findUserById(userId);}@RequestMapping(value = "/userAge", method = RequestMethod.GET)public List<User> findByUserAge(@RequestParam(value = "userAge", required = true) int userAge) {System.out.println("开始查询...");return userService.findUserByAge(userAge);}
}

3.5 主程序

则是用于从main方法启动应用的类。

默认，它会执行以下步骤：

1.创建一个合适的实例 （取决于）。

2.注册一个ource，以便将命令行参数作为 。

3.刷新 ，加载所有单例beans。

4.激活所有 beans。

直接使用main启动该类，便自动化配置了。

该类的一些注解说明。:

n：开启组件扫描和自动配置。

: 接口类扫描包配置

代码如下：

package com.dk;import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;/*** @Description: 基于SpringBoot开发一个Restful服务实现增删改查功能* @Author Cheri* @Date 2019/8/4 - 16:31* @Version V1.0**/
@SpringBootApplication
@MapperScan("com.dk.dao")
public class SpringBootRestfulApplication {public static void main(String[] args) {SpringApplication.run(SpringBootRestfulApplication.class,args);}}

四、代码测试

代码编写完之后，我们进行代码的测试。

启动 之后，使用工具或IDEA 插件进行接口的测试。

IDEA 插件测试结果如下:

[外链图片转存失败(img--81)(C:\Users\Cheri\\小Q书桌-截图\yr.png)]

这里只使用了一个get和post测试，实际方法都测试过了

项目我放到码云上面去了:

总结

@Description: 基于SpringBoot开发一个Restful服务实现增删改查功能* @Author Cheri* @Date 2019/8/4 - 16:31* @Version V1.0**/
@SpringBootApplication
@MapperScan("com.dk.dao")
public class SpringBootRestfulApplication {public static void main(String[] args) {SpringApplication.run(SpringBootRestfulApplication.class,args);}}

四、代码测试

代码编写完之后，我们进行代码的测试。

启动 之后，使用工具或IDEA 插件进行接口的测试。

IDEA 插件测试结果如下:

这里只使用了一个get和post测试，实际方法都测试过了

最后说下：状态码设计

新建base文件夹存放全局基础信息

设计如下两个类封装状态码信息：

package com.dk.base;/*** @author dk*/
public class RestResponse<T> {private int code;private String message;private T response;public RestResponse(int code, String message) {this.code = code;this.message = message;}public RestResponse(int code, String message, T response) {this.code = code;this.message = message;this.response = response;}public static RestResponse ok() {SystemCode systemCode = SystemCode.OK;return new RestResponse(systemCode.getCode(), systemCode.getMessage());}public static <F> RestResponse<F> ok(F response) {SystemCode systemCode = SystemCode.OK;return new RestResponse<>(systemCode.getCode(), systemCode.getMessage(), response);}public int getCode() {return code;}public void setCode(int code) {this.code = code;}public String getMessage() {return message;}public void setMessage(String message) {this.message = message;}public T getResponse() {return response;}public void setResponse(T response) {this.response = response;}
}

package com.dk.base;/*** @author dk*/
public enum SystemCode {/*** OK*/OK(1, "Ok"),/*** AccessTokenError*/AccessTokenError(400, "AccessToken Unvalidated"),/*** UNAUTHORIZED*/UNAUTHORIZED(401, "User UNAUTHORIZED"),/*** UNAUTHORIZED*/AuthError(402, "Username or Password error"),/*** InnerError*/InnerError(500, "Api Inner Exception"),/*** RestFulInnerError*/RestFulInnerError(501, "Web Api Inner Exception");int code;String message;SystemCode(int code, String message) {this.code = code;this.message = message;}public int getCode() {return code;}public String getMessage() {return message;}
}

在层的添加方法

  //状态码设计@RequestMapping(value = "/userAge2", method = RequestMethod.GET)public RestResponse<List<User>> findByUserAge2(@RequestParam(value = "userAge", required = true) int userAge) {System.out.println("开始查询...");return RestResponse.ok(userService.findUserByAge(userAge));}

完整代码如下：

package com.dk.controller;import com.dk.base.RestResponse;
import com.dk.bean.User;
import com.dk.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;import java.util.List;/*** @Description: TODO* @Author Cheri* @Date 2019/8/4 - 17:26* @Version V1.0**/
@RestController
@RequestMapping(value = "/api/user")
public class UserRestController {@Autowiredprivate UserService userService;@RequestMapping(value = "/addUser", method = RequestMethod.POST)public boolean addUser(@RequestBody User user) {System.out.println("开始新增...");return userService.addUser(user);}@RequestMapping(value = "/updateUser", method = RequestMethod.PUT)public boolean updateUser(User user) {System.out.println("开始更新...");return userService.updateUser(user);}@RequestMapping(value = "/deleteUser", method = RequestMethod.DELETE)public boolean delete(@RequestParam(value = "userName", required = true) int userId) {System.out.println("开始删除...");return userService.deleteUser(userId);}@RequestMapping(value = "/userName", method = RequestMethod.GET)public User findByUserName(@RequestParam(value = "userName", required = true) String userName) {System.out.println("开始查询...");return userService.findUserByName(userName);}@RequestMapping(value = "/userId", method = RequestMethod.GET)public User findByUserId(@RequestParam(value = "userId", required = true) int userId) {System.out.println("开始查询...");return userService.findUserById(userId);}@RequestMapping(value = "/userAge", method = RequestMethod.GET)public List<User> findByUserAge(@RequestParam(value = "userAge", required = true) int userAge) {System.out.println("开始查询...");return userService.findUserByAge(userAge);}//状态码设计@RequestMapping(value = "/userAge2", method = RequestMethod.GET)public RestResponse<List<User>> findByUserAge2(@RequestParam(value = "userAge", required = true) int userAge) {System.out.println("开始查询...");return RestResponse.ok(userService.findUserByAge(userAge));}
}

最后使用测试插件测试下：见下图正常返指定格式数据

状态码设计要结合业务和http规范，大家统一决定即可

项目我放到码云上面去了:

总结

以上所述介绍的基于开发一个服务实现增删改查功能，又复习一遍项目编码开发流程，