使用SpringBoot開發Restful服務實現增刪改查功能

2024-07-13 10:16:26

字體：大中小

來源：轉載

供稿：網友

在去年的時候，在各種渠道中略微的了解了SpringBoot，在開發web項目的時候是如何的方便、快捷。但是當時并沒有認真的去學習下，畢竟感覺自己在Struts和SpringMVC都用得不太熟練。不過在看了很多關于SpringBoot的介紹之后，并沒有想象中的那么難，于是開始準備學習SpringBoot。在閑暇之余的時候，看了下SpringBoot實戰以及一些大神關于SpringBoot的博客之后，開始寫起了我的第一個SpringBoot的項目。在能夠對SpringBoot進行一些簡單的開發Restful風格接口實現CRUD功能之后，于是便有了本篇博文。

SpringBoot介紹

Spring Boot是由Pivotal團隊提供的全新框架，其設計目的是用來簡化新Spring應用的初始搭建以及開發過程。該框架使用了特定的方式來進行配置，從而使開發人員不再需要定義樣板化的配置。

簡單的來說就是，只需幾個jar和一些簡單的配置，就可以快速開發項目。

假如我就想簡單的開發一個對外的接口，那么只需要以下代碼就可以了。

一個主程序啟動springBoot

@SpringBootApplicationpublic class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); }}

控制層

@RestControllerpublic 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 - 應用配置文件，應用啟動會自動讀取配置

spring,boot,restful

2.2 自定義配置文件

一般我們需要一些自定義的配置，例如配置jdbc的連接配置，在這里我們可以用 application.properties 進行配置。數據源實際的配置以各位的為準。

## 數據源配置spring.datasource.url=jdbc:mysql://localhost:3306/springBoot?useUnicode=true&characterEncoding=utf8spring.datasource.username=rootspring.datasource.password=123456spring.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;@Mapperpublic 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日 */@Servicepublic 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("程序正在運行..."); }}