使用SpringBoot开发Restful服务实现增删改查功能

在去年的时候，在各种渠道中略微的了解了springboot，在开发web项目的时候是如何的方便、快捷。但是当时并没有认真的去学习下，毕竟感觉自己在struts和springmvc都用得不太熟练。不过在看了很多关于springboot的介绍之后，并没有想象中的那么难，于是开始准备学习springboot。 在闲暇之余的时候，看了下springboot实战以及一些大神关于springboot的博客之后，开始写起了我的第一个springboot的项目。在能够对springboot进行一些简单的开发restful风格接口实现crud功能之后，于是便有了本篇博文。

springboot介绍

spring boot是由pivotal团队提供的全新框架，其设计目的是用来简化新spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。

简单的来说就是，只需几个jar和一些简单的配置，就可以快速开发项目。

假如我就想简单的开发一个对外的接口，那么只需要以下代码就可以了。

一个主程序启动springboot

@springbootapplication
public class application {
 public static void main(string[] args) {
 springapplication.run(application.class, args);
 }
}

控制层

@restcontroller
public class helloworldcontroller {
 @requestmapping("/hello")
 public string index() {
 return "hello world";
 }
 }

成功启动主程序之后，编写控制层，然后在浏览器输入 http://localhost:8080//hello 便可以查看信息。

感觉使用springboot开发程序是不是非常的简单呢！

用springboot实战的话来说：

这里没有配置，没有web.xml，没有构建说明，甚至没有应用服务器，但这就是整个应用程序了。springboot会搞定执行应用程序所需的各种后勤工作，你只要搞定应用程序的代码就好。

基于springboot开发一个restful服务

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

一、开发准备

 

1.1 数据库和表

create database `springboot`;
use `springboot`;
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相关依赖

springboot最核心的jar

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

<parent>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-starter-parent</artifactid>
 <version>1.5.9.release</version>
 <relativepath/>
 </parent>
 <properties>
 <project.build.sourceencoding>utf-8</project.build.sourceencoding>
 <java.version>1.7</java.version>
 <mybatis-spring-boot>1.2.0</mybatis-spring-boot>
 <mysql-connector>5.1.39</mysql-connector>
 </properties>
 <dependencies>
 <dependency>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-starter-web</artifactid>
 </dependency>
 <dependency>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-starter-thymeleaf</artifactid>
 </dependency>
 <dependency>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-starter-data-jpa</artifactid>
 </dependency>
 <dependency>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-devtools</artifactid>
 <optional>true</optional>
 </dependency>
 <dependency>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-starter-test</artifactid>
 <scope>test</scope>
 </dependency>
 <!-- spring boot mybatis 依赖 -->
 <dependency>
 <groupid>org.mybatis.spring.boot</groupid>
 <artifactid>mybatis-spring-boot-starter</artifactid>
 <version>${mybatis-spring-boot}</version>
 </dependency>
 <!-- mysql 连接驱动依赖 -->
 <dependency>
 <groupid>mysql</groupid>
 <artifactid>mysql-connector-java</artifactid>
 <version>${mysql-connector}</version>
 </dependency>
 </dependencies>
 <build>
 <plugins>
 <!--运用springboot 插件 使用spring-boot-devtools模块的应用,当classpath中的文件有改变时，会自动重启！ -->
 <plugin>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-maven-plugin</artifactid>
 <configuration>
  <fork>true</fork>
 </configuration>
 </plugin>
 </plugins>
 </build>

二、工程说明

 

2.1工程结构图:

com.pancm.web - controller 层
com.pancm.dao - 数据操作层 dao
com.pancm.bean - 实体类
com.pancm.bean.service - 业务逻辑层
application - 应用启动类
application.properties - 应用配置文件，应用启动会自动读取配置

2.2 自定义配置文件

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

## 数据源配置
spring.datasource.url=jdbc:mysql://localhost:3306/springboot?useunicode=true&characterencoding=utf8
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.driver
## mybatis 配置
# 配置为 com.pancm.bean 指向实体类包路径。
mybatis.typealiasespackage=com.pancm.bean
# 配置为 classpath 路径下 mapper 包下，* 代表会扫描所有 xml 文件。
mybatis.mapperlocations=classpath\:mapper/*.xml

三、代码编写

 

3.1 pojo类user的编写

来到重点的代码这快了。

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

代码如下

public class user {
 /** 编号 */
 private int id;
 /** 姓名 */
 private string name;

 /** 年龄 */
 private int age;

 public user(){
 }
 public class user {
 /** 编号 */
 private int id;
 /** 姓名 */
 private string name;

 /** 年龄 */
 private int age;

 public user(){
 }
// getter和 setter 略
}

3.2 dao层编写

在以前的dao层这块，hibernate和mybatis 都可以使用注解或者使用mapper配置文件。在这里我们使用spring的jpa来完成crud。

说明:

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

第一种是xml的mapper配置。

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

import org.apache.ibatis.annotations.delete;
import org.apache.ibatis.annotations.insert;
import org.apache.ibatis.annotations.mapper;
import org.apache.ibatis.annotations.result;
import org.apache.ibatis.annotations.results;
import org.apache.ibatis.annotations.select;
import org.apache.ibatis.annotations.update;
import org.springframework.data.repository.query.param;
import com.pancm.bean.user;
@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}")
 user findbyage( int userage);
}

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

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

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

param:sql条件的字段。

insert、select、update、delete:对应数据库的增、查、改、删。

3.3 service 业务逻辑层

这块和hibernate、mybatis的基本一样。

代码如下：

接口

import com.pancm.bean.user;
/**
 *
* title: userservice
* description:用户接口
* version:1.0.0
* @author pancm
* @date 2018年1月9日
 */
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);
 /**
 * 根据用户id查询用户信息
 * @param userage
 */
 user finduserbyage(int userage);
}

实现类

import org.springframework.beans.factory.annotation.autowired;
import org.springframework.stereotype.service;
import com.pancm.bean.user;
import com.pancm.dao.userdao;
import com.pancm.service.userservice;
/**
 *
* title: userserviceimpl
* description:
* 用户操作实现类
* version:1.0.0
* @author pancm
* @date 2018年1月9日
 */
@service
public class userserviceimpl implements userservice {
 @autowired
 private userdao userdao;
 @override
 public boolean adduser(user user) {
 boolean flag=false;
 try{
 userdao.adduser(user);
 flag=true;
 }catch(exception e){
 e.printstacktrace();
 }
 return flag;
 }
 @override
 public boolean updateuser(user user) {
 boolean flag=false;
 try{
 userdao.updateuser(user);
 flag=true;
 }catch(exception e){
 e.printstacktrace();
 }
 return flag;
 }
 @override
 public boolean deleteuser(int id) {
 boolean flag=false;
 try{
 userdao.deleteuser(id);
 flag=true;
 }catch(exception e){
 e.printstacktrace();
 }
 return flag;
 }
 @override
 public user finduserbyname(string username) {
 return userdao.findbyname(username);
 }
 @override
 public user finduserbyid(int userid) {
 return userdao.findbyid(userid);
 }
 @override
 public user finduserbyage(int userage) {
 return userdao.findbyage(userage);
 }
}

3.4 controller 控制层

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

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

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

requestmapping: 接口路径配置。

method : 请求格式。

requestparam: 请求参数。

具体实现如下:

import org.springframework.beans.factory.annotation.autowired;
import org.springframework.web.bind.annotation.requestmapping;
import org.springframework.web.bind.annotation.requestmethod;
import org.springframework.web.bind.annotation.requestparam;
import org.springframework.web.bind.annotation.restcontroller;
import com.pancm.bean.user;
import com.pancm.service.userservice;
/**
 *
* title: userrestcontroller
* description:
* 用户数据操作接口
* version:1.0.0
* @author pancm
* @date 2018年1月9日
 */
@restcontroller
@requestmapping(value = "/api/user")
public class userrestcontroller {
 @autowired
 private userservice userservice;
 @requestmapping(value = "/adduser", method = requestmethod.post)
 public boolean adduser( 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 user findbyuserage(@requestparam(value = "userage", required = true) int userage) {
 system.out.println("开始查询...");
 return userservice.finduserbyid(userage);
 }
}

3.5 application 主程序

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

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

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

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

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

4.激活所有commandlinerunner beans。

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

ps:即使是现在我依旧觉得这个实在是太厉害了。

该类的一些注解说明。:

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

mapperscan: mapper 接口类扫描包配置

代码如下：

import org.mybatis.spring.annotation.mapperscan;
import org.springframework.boot.springapplication;
import org.springframework.boot.autoconfigure.springbootapplication;
/**
 *
* title: application
* description:
* springboot 主程序
* version:1.0.0
* @author pancm
* @date 2018年1月5日
 */
@springbootapplication
@mapperscan("com.pancm.dao")
public class application {
 public static void main(string[] args) {
 // 启动嵌入式的 tomcat 并初始化 spring 环境及其各 spring 组件
 springapplication.run(application.class, args);
 system.out.println("程序正在运行...");
 }
}

四、代码测试

 

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

启动application 之后，使用postman工具进行接口的测试。

测试结果如下:

这里只使用了一个get和post测试，实际方法都测试过了，但是感觉没必要贴图了。

项目我放到github上面去了: https://github.com/xuwujing/springboot

总结

以上所述是小编给大家介绍的基于springboot开发一个restful服务实现增删改查功能，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对服务器之家网站的支持！

原文链接：http://www.panchengming.com/2018/01/10/pancm67/?utm_source=tuicool&utm_medium=referral