基於SpringBoot開發一個Restful服務，實現增刪改查功能

来源:https://www.cnblogs.com/xuwujing/archive/2018/01/10/8260935.html
-Advertisement-
Play Games

前言 在去年的時候，在各種渠道中略微的瞭解了SpringBoot，在開發web項目的時候是如何的方便、快捷。但是當時並沒有認真的去學習下，畢竟感覺自己在Struts和SpringMVC都用得不太熟練。不過在看了很多關於SpringBoot的介紹之後，並沒有想象中的那麼難，於是開始準備學習Spring ...


前言

在去年的時候，在各種渠道中略微的瞭解了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工具進行介面的測試。
postman的使用教程可以看我的博客: http://www.panchengming.com/2017/04/24/pancm12/

測試結果如下:
這裡寫圖片描述

這裡寫圖片描述

這裡只使用了一個get和post測試，實際方法都測試過了，但是感覺沒必要貼圖了。
項目我放到github上面去了:
https://github.com/xuwujing/springBoot

如果覺得不錯，希望順便給個star。
到此，本文結束，謝謝閱讀。

版權聲明:
作者：虛無境
博客園出處：http://www.cnblogs.com/xuwujing
CSDN出處：http://blog.csdn.net/qazwsxpcm　　　　
個人博客出處：http://www.panchengming.com
原創不易，轉載請標明出處，謝謝！


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Java 寫三角形 空心三角形 菱形 空心菱形
    閑來無事，練習了一下Java基礎中的迴圈語句。練習迴圈語句，當然少不了，用*列印出來三角形、空心三角形、菱形等這樣的幾何圖形。 粗心大意，失誤兩次： 一、三角形 遇到一些小問題： 二、金字塔 由於三角形和金字塔的代碼差不多，只有少部分更改，圖也可以看的很清楚。所以下麵只寫一部分代碼好啦。 代碼實例： ...
  • K：java中的RMI(Remote Method Invocation)
    相關介紹:  RMI全稱是Remote Method Invocation，即遠程方法調用。它是一種電腦之間利用遠程對象互相調用，從而實現雙方通訊的一種通訊機制。使用這種機制，某一臺電腦(虛擬機)上的對象可以調用另外一臺電腦(虛擬機)上的對象來獲取遠程數據。RMI是Enterpris ...
  • Java面向對象基礎 ——面試題
    1面向對象基礎 JAVA基礎語法自行掌握. 三大特性: 一 封裝:★★★★★ 概念:是指隱藏對象的屬性和實現細節，僅對外提供公共訪問方式。 好處：將變化隔離；便於使用；提高重用性；安全性。 封裝原則：將不需要對外提供的內容都隱藏起來，把屬性都隱藏，提供公共方法對其訪問。 單例設計模式：★★★★★(必 ...
  • PHP錯誤類型與處理
    1.PHP錯誤級別 E_ERROR嚴重錯誤，腳本終止執行 E_WARNING警告，非嚴重錯誤，腳本繼續執行 E_NOTICE提示，不是很重要 代碼實例 結果 可以看到在NOTICE 和 WARNING之後，語句繼續執行，而ERROR之後的語句就沒有執行，如果將第5行的代碼換到第1行那麼後面的兩條語句 ...
  • 數據結構之線性表（順序表）
    順序表 1.順序表定義：線性表的順序表示指的是用一組地址連續的存儲單元依次存儲線性表的數據元素。假設線性表的每個元素需占用L個 存儲單元，並以所占的第一個單元的存儲地址作為數據元素的存儲位置。則線性表中第i+1個數據元素的存儲位置LOC(ai+1)和第i個數據 元素的存儲位置LOC(ai)之間滿足下 ...
  • 通過指針引用字元串
    （一）一個指針引用字元串的小例子 把字元串a複製到字元串b （二）字元指針做函數參數 實參和形參都可以選擇字元數組名和字元指針變數，但存在區別：（1）編譯時為字元數組分配若幹存儲單元，以存放個元素的值，而對字元指針變數，只分配一個存儲單元（2）指針變數的值是可以改變的，而數組名代表一個固定的值（數組 ...
  • LOJ #115. 無源匯有上下界可行流
    #115. 無源匯有上下界可行流 描述 這是一道模板題。 n n n 個點，m m m 條邊，每條邊 e e e 有一個流量下界 lower(e) \text{lower}(e) lower(e) 和流量上界 upper(e) \text{upper}(e) upper(e)，求一種可行方案使得在所 ...
  • 函數重載(overload)
    重載的定義及特點 在同一個類中，允許存在一個以上的同名函數， 只要他們的參數個數或者參數類型不同(不僅指兩個重載方法的參數類型不同，還指相同參數擁有不同的參數類型順序)就構成重載。重載只和參數列表有關係，跟返回值類型無關，即返回值類型不能作為重載的條件。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類