一、springboot整合mybaits
(1)新建maven project;
新建一個maven project,取名為:spring-boot-mybatis
(2)在pom.xml文件中引入相關依賴;
在pom.xml中加入依賴:mysql驅動,mybatis依賴包,mysql分頁PageHelper:
<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.kfit</groupId>
<artifactId>spring-boot-mybatis</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>spring-boot-mybatis</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- jdk版本號,angel在這里使用1.8,大家修改為大家本地配置的jdk版本號即可 -->
<java.version>1.8</java.version>
</properties>
<!--
spring boot 父節點依賴,
引入這個之后相關的引入就不需要添加version配置,
spring boot會自動選擇最合適的版本進行添加。
-->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.3.3.RELEASE</version>
</parent>
<dependencies>
<!-- spring boot web支持:mvc,aop... -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mysql 數據庫驅動. -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--
spring-boot mybatis依賴:
請不要使用1.0.0版本,因為還不支持攔截器插件,
1.1.1 是博主寫帖子時候的版本,大家使用最新版本即可
-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.1.1</version>
</dependency>
<!--
MyBatis提供了攔截器接口,我們可以實現自己的攔截器,
將其作為一個plugin裝入到SqlSessionFactory中。
Github上有位開發者寫了一個分頁插件,我覺得使用起來還可以,挺方便的。
Github項目地址: https://github.com/pagehelper/Mybatis-PageHelper
-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>4.1.0</version>
</dependency>
</dependencies>
</project>
(3)創建啟動類App.java >com.kfit.App.java
package com.kfit;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* 啟動類;
* @author Angel(QQ:412887952)
* @version v.0.1
*/
@SpringBootApplication
@MapperScan("com.kfit.*.mapper")
publicclass App {
publicstaticvoid main(String[] args) {
SpringApplication.run(App.class, args);
}
}
這里和以往不一樣的地方就是MapperScan的注解,這個是會掃描該包下的接口。
這里我們使用注解的方式進行使用MyBatis,當然您也可以使用xml文件的方式進行使用。
(4)在application.properties添加配置文件;
Mysql的配置,這個我們已經是輕車熟路了:
########################################################
###datasource
########################################################
spring.datasource.url = jdbc:mysql://localhost:3306/test
spring.datasource.username = root
spring.datasource.password = root
spring.datasource.driverClassName = com.mysql.jdbc.Driver
spring.datasource.max-active=20
spring.datasource.max-idle=8
spring.datasource.min-idle=8
spring.datasource.initial-size=10
(5)編寫Demo測試類;
測試實體類com.kfit.demo.bean.Demo:
package com.kfit.demo.bean;
/**
* 測試類.
* @author Angel(QQ:412887952)
* @version v.0.1
*/
publicclass Demo {
private long id;
private String name;
public long getId() {
returnid;
}
public void setId(longid) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
(6)編寫DemoMapper;
MyBatis使用類,這里主要是@select進行使用.
com.kfit.demo.mapper.DemoMappper:
package com.kfit.demo.mapper;
import java.util.List;
import org.apache.ibatis.annotations.Select;
import com.kfit.demo.bean.Demo;
public interface DemoMappper {
@Select("select *from Demo where name = #{name}")
public List<Demo> likeName(String name);
@Select("select *from Demo where id = #{id}")
public Demo getById(long id);
@Select("select name from Demo where id = #{id}")
public String getNameById(long id);
}
(7)編寫DemoService
com.kfit.demo.service.DemoService:
package com.kfit.demo.service;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.kfit.demo.bean.Demo;
import com.kfit.demo.mapper.DemoMappper;
@Service
public class DemoService {
@Autowired
private DemoMappper demoMappper;
public List<Demo> likeName(String name){
return demoMappper.likeName(name);
}
}
(8)編寫DemoController;
com.kfit.demo.controller.DemoController:
package com.kfit.demo.controller;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.github.pagehelper.PageHelper;
import com.kfit.demo.bean.Demo;
import com.kfit.demo.service.DemoService;
@RestController
publicclass DemoController {
@Autowired
private DemoService demoService;
@RequestMapping("/likeName")
public List<Demo> likeName(String name){
return demoService.likeName(name);
}
}
運行訪問:http://127.0.0.1:8080/likeName?name=張三 就可以看到全部的數據了。
(9)加入PageHelper
這里與其說集成分頁插件,不如說是介紹如何集成一個plugin。MyBatis提供了攔截器接口,我們可以實現自己的攔截器,將其作為一個plugin裝入到SqlSessionFactory中。
Github上有位開發者寫了一個分頁插件,我覺得使用起來還可以,挺方便的。
Github項目地址: https://github.com/pagehelper/Mybatis-PageHelper
當然需要添加相應的依賴包了,我們在上面已經配置了,這里簡單說下:
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>4.1.0</version>
</dependency>
新增MyBatisConfiguration.java
com.kfit.config.mybatis.MyBatisConfiguration:
package com.kfit.config.mybatis;
import java.util.Properties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.github.pagehelper.PageHelper;
/**
* 注冊MyBatis分頁插件PageHelper
* @author Angel(QQ:412887952)
* @version v.0.1
*/
@Configuration
public class MyBatisConfiguration {
@Bean
public PageHelper pageHelper() {
System.out.println("MyBatisConfiguration.pageHelper()");
PageHelper pageHelper = new PageHelper();
Properties p = new Properties();
p.setProperty("offsetAsPageNum", "true");
p.setProperty("rowBoundsWithCount", "true");
p.setProperty("reasonable", "true");
pageHelper.setProperties(p);
return pageHelper;
}
}
分頁查詢測試
@RequestMapping("/likeName")
public List<Demo> likeName(String name){
PageHelper.startPage(1,1);
return demoService.likeName(name);
}
這個使用起來特別的簡單,只是在原來查詢的代碼之前加入了一句:
PageHelper.startPage(1,1);
第一個參數是第幾頁;
第二個參數是每頁顯示條數。
訪問http://127.0.0.1:8080/likeName?name=張三 進行測試。
二、springboot aop日志攔截
AOP為Aspect Oriented Programming的縮寫,意為:面向切面編程,通過預編譯方式和運行期動態代理實現程序功能的統一維護的一種技術。AOP是Spring框架中的一個重要內容,它通過對既有程序定義一個切入點,然后在其前后切入不同的執行內容,比如常見的有:打開數據庫連接/關閉數據庫連接、打開事務/關閉事務、記錄日志等。基於AOP不會破壞原來程序邏輯,因此它可以很好的對業務邏輯的各個部分進行隔離,從而使得業務邏輯各部分之間的耦合度降低,提高程序的可重用性,同時提高了開發的效率。
本文就是要通過AOP技術統一處理web請求的日志。
准備工作
因為需要對web請求做切面來記錄日志,所以先引入web模塊,並創建一個簡單的hello請求的處理。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
實現一個簡單請求處理:
@RestController
publicclass HelloController {
@RequestMapping("/hello")
public String hello(String name,int state){
return"name "+name+"---"+state;
}
}
這時候我們編寫一個啟動類啟動運行程序訪問:
http://127.0.0.1:8080/hello?name=林峰&state=1 就能看到頁面返回的信息了,但是現在還是不能進行攔截的。
引入AOP依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
在完成了引入AOP依賴包后,一般來說並不需要去做其他配置。也許在Spring中使用過注解配置方式的人會問是否需要在程序主類中增加@EnableAspectJAutoProxy
來啟用,實際並不需要。
可以看下面關於AOP的默認配置屬性,其中spring.aop.auto
屬性默認是開啟的,也就是說只要引入了AOP依賴后,默認已經增加了@EnableAspectJAutoProxy
。
# AOP spring.aop.auto=true # Add @EnableAspectJAutoProxy.
spring.aop.proxy-target-class=false # Whether subclass-based (CGLIB) proxies are to be created (true) as opposed to standard Java interface-based proxies (false).
我在做測試的時候,以上兩個配置我都沒有進行使用,請自行進行測試。
而當我們需要使用CGLIB來實現AOP的時候,需要配置spring.aop.proxy-target-class=true
,不然默認使用的是標准Java的實現。
實現Web層的日志切面
實現AOP的切面主要有以下幾個要素:
使用@Aspect注解將一個java類定義為切面類
使用@Pointcut定義一個切入點,可以是一個規則表達式,比如下例中某個package下的所有函數,也可以是一個注解等。
根據需要在切入點不同位置的切入內容
使用@Before在切入點開始處切入內容
使用@After在切入點結尾處切入內容
使用@AfterReturning在切入點return內容之后切入內容(可以用來對處理返回值做一些加工處理)
使用@Around在切入點前后切入內容,並自己控制何時執行切入點自身的內容
使用@AfterThrowing用來處理當切入內容部分拋出異常之后的處理邏輯
package com.kfit.config.aop.log;
import java.util.Arrays;
import java.util.Enumeration;
import javax.servlet.http.HttpServletRequest;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
/**
* 實現Web層的日志切面
* @author Angel(QQ:412887952)
* @version v.0.1
*/
@Aspect
@Component
@Order(-5)
public class WebLogAspect {
private Logger logger = LoggerFactory.getLogger(this.getClass());
/**
* 定義一個切入點.
* 解釋下:
*
* ~ 第一個 * 代表任意修飾符及任意返回值.
* ~ 第二個 * 任意包名
* ~ 第三個 * 代表任意方法.
* ~ 第四個 * 定義在web包或者子包
* ~ 第五個 * 任意方法
* ~ .. 匹配任意數量的參數.
*/
@Pointcut("execution(public * com.kfit.*.web..*.*(..))")
publicvoid webLog(){}
@Before("webLog()")
publicvoid doBefore(JoinPoint joinPoint){
// 接收到請求,記錄請求內容
logger.info("WebLogAspect.doBefore()");
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
// 記錄下請求內容
logger.info("URL : " + request.getRequestURL().toString());
logger.info("HTTP_METHOD : " + request.getMethod());
logger.info("IP : " + request.getRemoteAddr());
logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
logger.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
//獲取所有參數方法一:
Enumeration<String> enu=request.getParameterNames();
while(enu.hasMoreElements()){
String paraName=(String)enu.nextElement();
System.out.println(paraName+": "+request.getParameter(paraName));
}
}
@AfterReturning("webLog()")
publicvoid doAfterReturning(JoinPoint joinPoint){
// 處理完請求,返回內容
logger.info("WebLogAspect.doAfterReturning()");
}
}
整個代碼比較不好理解地方就是切點表達式,已經在注釋中詳細說明了,這里不再過多的介紹。編碼中需要根據您自己的包命名規范進行修改下。
這時候運行程序訪問 http://127.0.0.1:8080/hello?name=林峰&state=1 就可以看到控制台的打印信息了。
: WebLogAspect.doBefore()
: URL : http://127.0.0.1:8080/hello
: HTTP_METHOD : GET
: IP : 127.0.0.1
: CLASS_METHOD : com.kfit.demo.web.HelloController.hello
: ARGS : [林峰, 1]
name: 林峰
state: 1
: WebLogAspect.doAfterReturning()
: 耗時(毫秒) : 1
優化:AOP切面中的同步問題
在WebLogAspect切面中,分別通過doBefore和doAfterReturning兩個獨立函數實現了切點頭部和切點返回后執行的內容,若我們想統計請求的處理時間,就需要在doBefore處記錄時間,並在doAfterReturning處通過當前時間與開始處記錄的時間計算得到請求處理的消耗時間。
那么我們是否可以在WebLogAspect切面中定義一個成員變量來給doBefore和doAfterReturning一起訪問呢?是否會有同步問題呢?
的確,直接在這里定義基本類型會有同步問題,所以我們可以引入ThreadLocal對象,像下面這樣進行記錄改造代碼為如下:
package com.kfit.config.aop.log;
import java.util.Arrays;
import java.util.Enumeration;
import javax.servlet.http.HttpServletRequest;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
/**
* 實現Web層的日志切面
* @author Angel(QQ:412887952)
* @version v.0.1
*/
@Aspect
@Component
public class WebLogAspect {
private Logger logger = LoggerFactory.getLogger(this.getClass());
ThreadLocal<Long> startTime = new ThreadLocal<Long>();
/**
* 定義一個切入點.
* 解釋下:
*
* ~ 第一個 * 代表任意修飾符及任意返回值.
* ~ 第二個 * 任意包名
* ~ 第三個 * 代表任意方法.
* ~ 第四個 * 定義在web包或者子包
* ~ 第五個 * 任意方法
* ~ .. 匹配任意數量的參數.
*/
@Pointcut("execution(public * com.kfit.*.web..*.*(..))")
publicvoid webLog(){}
@Before("webLog()")
publicvoid doBefore(JoinPoint joinPoint){
startTime.set(System.currentTimeMillis());
// 接收到請求,記錄請求內容
logger.info("WebLogAspect.doBefore()");
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
// 記錄下請求內容
logger.info("URL : " + request.getRequestURL().toString());
logger.info("HTTP_METHOD : " + request.getMethod());
logger.info("IP : " + request.getRemoteAddr());
logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
logger.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
//獲取所有參數方法一:
Enumeration<String> enu=request.getParameterNames();
while(enu.hasMoreElements()){
String paraName=(String)enu.nextElement();
System.out.println(paraName+": "+request.getParameter(paraName));
}
}
@AfterReturning("webLog()")
publicvoid doAfterReturning(JoinPoint joinPoint){
// 處理完請求,返回內容
logger.info("WebLogAspect.doAfterReturning()");
logger.info("耗時(毫秒) : " + (System.currentTimeMillis() - startTime.get()));
}
}
優化:AOP切面的優先級
由於通過AOP實現,程序得到了很好的解耦,但是也會帶來一些問題,比如:我們可能會對Web層做多個切面,校驗用戶,校驗頭信息等等,這個時候經常會碰到切面的處理順序問題。
所以,我們需要定義每個切面的優先級,我們需要@Order(i)注解來標識切面的優先級。i的值越小,優先級越高。假設我們還有一個切面是CheckNameAspect用來校驗name必須為didi,我們為其設置@Order(10),而上文中WebLogAspect設置為@Order(5),所以WebLogAspect有更高的優先級,這個時候執行順序是這樣的:
在@Before中優先執行@Order(5)的內容,再執行@Order(10)的內容
在@After和@AfterReturning中優先執行@Order(10)的內容,再執行@Order(5)的內容
所以我們可以這樣子總結:
在切入點前的操作,按order的值由小到大執行
在切入點后的操作,按order的值由大到小執行
在實際中order值可以設置為負值,確保是第一個進行執行的。
項目代碼:https://github.com/zrbfree/spring-boot-mybatis.git
多謝大牛林祥纖,介紹的比較詳細,我在這里不一一描述,參考其博客實現項目代碼!!!