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

時間  2019-11-11
標籤 基於 springboot 開發 一個 restful 服務 實現 增刪 功能 欄目 Spring 简体版
原文   原文鏈接

前言

在去年的時候，在各類渠道中略微的瞭解了SpringBoot，在開發web項目的時候是如何的方便、快捷。可是當時並無認真的去學習下，畢竟感受本身在Struts和SpringMVC都用得不太熟練。不過在看了不少關於SpringBoot的介紹以後，並無想象中的那麼難，因而開始準備學習SpringBoot。 在閒暇之餘的時候，看了下SpringBoot實戰以及一些大神關於SpringBoot的博客以後，開始寫起了個人第一個SpringBoot的項目。在可以對SpringBoot進行一些簡單的開發Restful風格接口實現CRUD功能以後，因而便有了本篇博文。java

SpringBoot介紹

Spring Boot是由Pivotal團隊提供的全新框架，其設計目的是用來簡化新Spring應用的初始搭建以及開發過程。該框架使用了特定的方式來進行配置，從而使開發人員再也不須要定義樣板化的配置。
簡單的來講就是，只需幾個jar和一些簡單的配置，就能夠快速開發項目。
假如我就想簡單的開發一個對外的接口，那麼只須要如下代碼就能夠了。mysql

一個主程序啓動springBootgit

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

控制層github

@RestController
public class HelloWorldController {
    @RequestMapping("/hello")
    public String index() {     
        return "Hello World";
    }
 }

成功啓動主程序以後，編寫控制層，而後在瀏覽器輸入 http://localhost:8080//hello 即可以查看信息。web

感受使用SpringBoot開發程序是否是很是的簡單呢！
用SpringBoot實戰的話來講：spring

這裏沒有配置，沒有web.xml，沒有構建說明，甚至沒有應用服務器，但這就是整個應用程序了。SpringBoot會搞定執行應用程序所需的各類後勤工做，你只要搞定應用程序的代碼就好。sql

基於SpringBoot開發一個Restful服務

1、開發準備

1.1 數據庫和表

首先，咱們須要在MySql中建立一個數據庫和一張表
數據庫的名稱爲 springboot，表名稱爲 t_user
腳本以下:數據庫

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相關依賴

由於咱們使用Maven建立的，因此須要添加SpringBoot的相關架包。
這裏Maven的配置以下:
springBoot最核心的jar
spring-boot-starter ：核心模塊，包括自動配置支持、日誌和YAML；apache

<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、工程說明

成功建立好數據庫以及下載好相應架包以後。
咱們來正式開發SpringBoot項目。json

2.1工程結構圖:

首先肯定工程結構，這裏我就簡單的說明下了。

com.pancm.web - Controller 層
com.pancm.dao - 數據操做層 DAO
com.pancm.bean - 實體類
com.pancm.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、代碼編寫

在建立好相關工程目錄以後，咱們開始來編寫相應的代碼。

3.1 實體類編寫

因爲咱們這裏只是用於測試，只在數據庫中建立了一張t_user表，因此這裏咱們就只建立一個User實體類，裏面的字段對應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：
第一種是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 where name=#{userName}")
    User findByName(@Param("userName") String userName);
   
   /**
     * 查詢全部
     */
    @Select("SELECT id,name,age FROM t_user")     
    List<User> findAll();
    
     
}

說明:

  • 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);
    
 
    
    /**
     * 查詢全部
     * @return
     */
    List<User> findAll();
}

實現類

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 List<User> findAll() {
        return userDao.findAll();
    }
}

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 = "/user", method = RequestMethod.POST)
    public boolean addUser( User user) {
        System.out.println("開始新增...");
        return userService.addUser(user);
    }
    
    @RequestMapping(value = "/user", method = RequestMethod.PUT)
    public boolean updateUser( User user) {
        System.out.println("開始更新...");
        return userService.updateUser(user);
    }
    
    @RequestMapping(value = "/user", method = RequestMethod.DELETE)
    public boolean delete(@RequestParam(value = "userName", required = true) int userId) {
        System.out.println("開始刪除...");
        return userService.deleteUser(userId);
    }
    
    
    @RequestMapping(value = "/user", method = RequestMethod.GET)
    public User findByUserName(@RequestParam(value = "userName", required = true) String userName) {
        System.out.println("開始查詢...");
        return userService.findUserByName(userName);
    }
    
    
    @RequestMapping(value = "/userAll", method = RequestMethod.GET)
    public List<User> findByUserAge() {
        System.out.println("開始查詢全部數據...");
        return userService.findAll();
    }
}

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("程序正在運行...");
    }
}

4、代碼測試

代碼編寫完以後，咱們進行代碼的測試。
啓動Application 以後，使用postman工具進行接口的測試。
postman的使用教程能夠看個人博客: http://www.panchengming.com/2017/04/24/pancm12/

測試結果以下:

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

若是以爲不錯，但願順便給個star。 到此，本文結束，謝謝閱讀。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程