最近有項目需要使用java語言開發(fā)數(shù)據(jù)接口慈缔,整體框架需要符合微服務架構(gòu)嘀趟,在網(wǎng)上查找了相關資料,最終選定了Springcloud+Springboot的架構(gòu),此文主要記錄Mybatis在Springboot下的使用逞带,一方面作為學習日記,另一方面也希望對正在學習springboot的朋友們有一定幫助惨远。
全文包含3部分內(nèi)容:
- 項目搭建
- 數(shù)據(jù)庫配置
- 數(shù)據(jù)操作層編寫
項目創(chuàng)建
本文中使用的編輯器為Intellij Idea躯枢,創(chuàng)建流程也是基于Intellij,具體步驟如下:
-
在New Project面板中中選擇Spring Initializr司忱,點擊Next按鈕皇忿,如下圖:
- 填寫項目的相關信息,Type一行根據(jù)使用習慣選擇Maven或者Gradle就好坦仍。
-
選擇項目的相關依賴鳍烁,該文章中Web選項里選擇了Web,Sql選項里面勾選Mybatis及Mysql后按著向?qū)瓿身椖縿?chuàng)建繁扎,如下圖:
-
最終生成的項目目錄結(jié)構(gòu)如下圖:
- 如下為項目的依賴配置文件代碼:
<?xml version="1.0" encoding="UTF-8"?>
<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">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>demo</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.4.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
數(shù)據(jù)庫配置
在Springboot中幔荒,數(shù)據(jù)庫的配置非常簡單,在resources文件夾下的application.propertites編寫相關配置即可梳玫,喜歡yml格式的也可以換成application.yml爹梁,具體如下:
mybatis.type-aliases-package=com.aryan.entity
spring.datasource.driverClassName = com.mysql.jdbc.Driver
spring.datasource.url = jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8
spring.datasource.username = root
spring.datasource.password = demopc
需注意第一行配置,com.aryan.entity指定了后面的mybatis數(shù)據(jù)庫實體從哪個包進行查找提澎。
數(shù)據(jù)庫操作層編寫
實體層編寫
- 在main的src目錄下新建package姚垃,命名為entity,作為mybatis的數(shù)據(jù)庫實體層盼忌,與前面數(shù)據(jù)庫配置相對應积糯。
- 創(chuàng)建Product實體,代碼如下:
package com.aryan.entity;
import java.io.Serializable;
/**
* Created by Aryan on 2017/6/25.
*/
public class ProductEntity implements Serializable {
private Long id;
private String name;
private String code;
public ProductEntity() {
super();
}
public ProductEntity(Long id, String name, String code) {
super();
this.id = id;
this.name = name;
this.code = code;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
@Override
public String toString() {
return "ProductEntity{" +
"id=" + id +
", name='" + name + '\'' +
", code='" + code + '\'' +
'}';
}
}
Dao層編寫
- 在main目錄的src文件夾下新建package碴犬,命名為mapper絮宁,該package作為項目的dao層映射,將sql語句與調(diào)用的方法關聯(lián)起來服协,整體使用起來比較靈活绍昂。
- 在mapper包下新建ProductMapper接口,編寫相關數(shù)據(jù)庫操作方法,具體代碼如下:
package com.aryan.mapper;
import com.aryan.entity.ProductEntity;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Select;
import java.util.List;
/**
* Created by Aryan on 2017/6/25.
*/
public interface ProductMapper {
@Select("SELECT * FROM products")
List<ProductEntity> getAll();
@Select("SELECT * FROM Products WHERE id = #{id}")
ProductEntity getOne(Long id);
@Insert("INSERT INTO products(name,code) VALUES(#{name}, #{code})")
void insert(ProductEntity product);
}
控制器編寫
- 在main目錄src文件夾下新建package窘游,命名為controller唠椭,該package作為MVC中的控制器,主要編寫了產(chǎn)品添加及查詢的路由忍饰,具體代碼如下:
package com.aryan.controller;
import com.aryan.entity.ProductEntity;
import com.aryan.mapper.ProductMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/**
* Created by Aryan on 2017/6/25.
*/
@RestController
public class ProductController {
@Autowired
private ProductMapper productMapper;
@RequestMapping(value = "/products")
public List<ProductEntity> getAll() {
return productMapper.getAll();
}
@RequestMapping(value = "/product/{id}")
public ProductEntity getOne(@PathVariable Long id) {
return productMapper.getOne(id);
}
@RequestMapping(value = "/product/add", method = RequestMethod.POST)
public void insert(@RequestBody ProductEntity product) {
productMapper.insert(product);
}
}
運行項目
- 運行項目前首先需要在Application入口文件中加上dao層配置贪嫂,添加@MapperScan("com.aryan.mapper")注解,代碼如下:
package com.aryan;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("com.aryan.mapper")
public class SpringBootMybatisApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootMybatisApplication.class, args);
}
}
- 直接運行該項目艾蓝, 運行成功后力崇,在進行api訪問時別忘記先把數(shù)據(jù)庫表生成好, 然后訪問http://localhost:8080/products 查看數(shù)據(jù)庫數(shù)據(jù)赢织,通過Postman或者Fiddler采用Post訪問http://localhost:8080/product/add 并傳遞產(chǎn)品數(shù)據(jù)亮靴,成功后可以查看表數(shù)據(jù)確認接口是否運行正常。
最后于置,整個項目完成后目錄結(jié)構(gòu)如下: