设为首页收藏本站
切换到宽版

电脑疯子技术论坛|电脑极客社区

 找回密码
 注册

QQ登录

只需一步，快速开始

电脑疯子技术论坛|电脑极客社区»技术论坛 › 电脑疯子|资源分享 › 电脑教程分享 › MyBatis集成P6Spy显示实际的SQL（代码教程） ...
返回列表 发新帖

[编程和数据库] MyBatis集成P6Spy显示实际的SQL（代码教程）

[复制链接]
zhaorong 发表于 2018-2-1 12:14:58 | 显示全部楼层 |阅读模式

在应用程序开发过程中，为了方便调试，通常都需要知道在DAO层，
程序执行的SQL是什么，而P6spy这个组件正是提供了该功能。

接下来将详细介绍P6Spy的详细使用。

一 系统集成P6spy

1 添加依赖

  1. <properties>
  2.         <p6spy.version>3.6.0</p6spy.version>
  3.         <druid.version>1.1.6</druid.version>
  4.     </properties>

  6.   <dependency>
  7.             <groupid>p6spy</groupid>
  8.             p6spy</artifactid>
  9.             <version>${p6spy.version}</version>
  10.         </dependency>

  12.         <dependency>
  13.             <groupid>com.alibaba</groupid>
  14.             druid</artifactid>
  15.             <version>${druid.version}</version>
  16.         </dependency>
复制代码


2 实现自定义的SQL输出格式

为了输出的内容足够的简洁，这里只保留了当期那时间，执行SQL的耗时以及执行的SQL语句

  1. package net.ittimeline.mybatis.practices.core;
  2. import com.alibaba.druid.sql.SQLUtils;
  3. import com.p6spy.engine.spy.appender.MessageFormattingStrategy;
  4. /**
  5. * @author tony ittimeline@163.com
  6. * @date 2018-01-30-下午10:45
  7. * @website wwww.ittimeline.net
  8. * @see
  9. * @since JDK8u162
  10. */
  11. public class CustomizeLineFormat implements MessageFormattingStrategy {

  13.     public String buildMessage(String now, long elapsed, String sql) {
  14.         StringBuffer content = new StringBuffer();
  15.         if (org.apache.commons.lang3.StringUtils.isNotEmpty(now) && org.apache.
  16. commons.lang3.StringUtils.isNotEmpty(Long.valueOf(elapsed).toString())
  17.                 && org.apache.commons.lang3.StringUtils.isNotEmpty(sql)) {
  18.             content.append("当前时间:" + now);
  19.             content.append(" SQL执行耗时(毫秒)为" + elapsed);
  20.             content.append(" SQL执行的语句是\n" + SQLUtils.formatMySql(sql)+"\n\n");
  21.         }
  22.         return content.toString();
  23.     }

  25.     @Override
  26.     public String formatMessage(int connectionId, String now, l
  27. ong elapsed, String category, String prepared, String sql) {
  28.         return buildMessage(now, elapsed, sql);
  29.     }

  31. }
复制代码


3 配置spy.properties

该文件只需要配置

modulelist，logfile，logMessageFormat，dateformat即可。

  1. ###
  2. # #%L
  3. # P6Spy
  4. # %%
  5. # Copyright (C) 2013 P6Spy
  6. # %%
  7. # Licensed under the Apache License, Version 2.0 (the "License");
  8. # you may not use this file except in compliance with the License.
  9. # You may obtain a copy of the License at
  10. #
  11. #      https://www.apache.org/licenses/LICENSE-2.0
  12. #
  13. # Unless required by applicable law or agreed to in writing, software
  14. # distributed under the License is distributed on an "AS IS" BASIS,
  15. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16. # See the License for the specific language governing permissions and
  17. # limitations under the License.
  18. # #L%
  19. ###

  21. #################################################################
  22. # P6Spy Options File                                            #
  23. # See documentation for detailed instructions                   #
  24. # https://p6spy.github.io/p6spy/2.0/configandusage.html          #
  25. #################################################################

  27. #################################################################
  28. # MODULES                                                       #
  29. #                                                               #
  30. # Module list adapts the modular functionality of P6Spy.        #
  31. # Only modules listed are active.                               #
  32. # (default is com.p6spy.engine.logging.P6LogFactory and         #
  33. # com.p6spy.engine.spy.P6SpyFactory)                            #
  34. # Please note that the core module (P6SpyFactory) can't be      #
  35. # deactivated.                                                  #
  36. # Unlike the other properties, activation of the changes on     #
  37. # this one requires reload.                                     #
  38. #################################################################
  39. #modulelist=com.p6spy.engine.spy.P6SpyFactory,com.p6spy.engine.logging.
  40. P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
  41. modulelist=com.p6spy.engine.spy.P6SpyFactory,com.p6spy.engine.logging.P
  42. 6LogFactory,com.p6spy.engine.outage.P6OutageFactory
  43. ################################################################
  44. # CORE (P6SPY) PROPERTIES                                      #
  45. ################################################################

  47. # A comma separated list of JDBC drivers to load and register.
  48. # (default is empty)
  49. #
  50. # Note: This is normally only needed when using P6Spy in an
  51. # application server environment with a JNDI data source or when
  52. # using a JDBC driver that does not implement the JDBC 4.0 API
  53. # (specifically automatic registration).
  54. #driverlist=
  55. #url="jdbc:p6spy:oracle:thin:@localhost:1521:orcl" \u5176\u4e2d\u7684p6spy\u5fc5\u9
  56. 87b\u8981\uff0c\u56e0\u4e3a\u8fd9\u6837\u624d\u4f1a\u88ab\u62e6\u622a
  57. #drive=com.p6spy.engine.spy.P6SpyDriver
  58. driverlist=com.mysql.jdbc.Driver
  59. # for flushing per statement
  60. # (default is false)
  61. #autoflush = false


  64. # prints a stack trace for every statement logged
  65. #stacktrace=false
  66. # if stacktrace=true, specifies the stack trace to print
  67. #stacktraceclass=

  69. # determines if property file should be reloaded
  70. # Please note: reload means forgetting all the previously set
  71. # settings (even those set during runtime - via JMX)
  72. # and starting with the clean table
  73. # (default is false)
  74. #reloadproperties=false

  76. # determines how often should be reloaded in seconds
  77. # (default is 60)
  78. #reloadpropertiesinterval=60

  80. # specifies the appender to use for logging
  81. # Please note: reload means forgetting all the previously set
  82. # settings (even those set during runtime - via JMX)
  83. # and starting with the clean table
  84. # (only the properties read from the configuration file)
  85. # (default is com.p6spy.engine.spy.appender.FileLogger)
  86. #appender=com.p6spy.engine.spy.appender.Slf4JLogger
  87. #appender=com.p6spy.engine.spy.appender.StdoutLogger

  89. #appender=com.p6spy.engine.spy.appender.FileLogger

  91. # name of logfile to use, note Windows users should make sure to use
  92. forward slashes in their pathname (e:/test/spy.log)
  93. # (used for com.p6spy.engine.spy.appender.FileLogger only)
  94. # (default is spy.log)
  95. #logfile = spy.log
  96. #windows \u7528\u6237\u8bf7\u7528 C:/spy.log \u683c\u5f0f\uff0c\u4e0d\u8981\u7528\
  97. logfile=mybatis-practices-core.log

  99. # append to the p6spy log file. if this is set to false the
  100. # log file is truncated every time. (file logger only)
  101. # (default is true)
  102. \uff03\u8ffd\u52a0\u5230 p6spy \u65e5\u5fd7\u6587\u4ef6\u300
  103. 2\u5982\u679c\u8bbe\u7f6e\u4e3afalse
  104. \uff03\u65e5\u5fd7\u6587\u4ef6\u88ab\u622a\u65ad\u6bcf\u6b21\u3002 \uff0
  105. 8\u53ea\u9650\u4e8e\u6587\u4ef6\u8bb0\u5f55\u5668\uff09
  106. \uff03\uff08\u9ed8\u8ba4\u4e3atrue\uff09
  107. #append=true

  109. # class to use for formatting log messages (default is: com.p6spy.engine.spy.appender.SingleLineFormat)
  110. #\u591a\u884c\u8f93\u51fa\u4e3a com.p6spy.engine.spy.appender.MultiLineFormat
  111. #\u884c\u7684\u65f6\u95f4\u683c\u5f0f\u5316\u914d\u7f6e\u5728 dateformat \u8bbe\u5b9a
  112. #current time|execution time|category|connection id|statement SQL String|effective SQL string
  113. #\u65e5\u5fd7\u683c\u5f0f\u4e3a \u5f53\u524d\u65f6\u95f4\u6233|\u6267\u884c\u8
  114. bed\u53e5\u82b1\u8d39\u7684\u65f
  115. 6\u95f4|\u8c03\u7528\u7684\u7c7b\u522b|connectionId|\u58f0\u660eSQL\u5b57\u7
  116. b26\u4e32|\u6709\u6548\u7684SQL\u5b57\u7b26\u4e32
  117. #logMessageFormat=com.p6spy.engine.spy.appender.SingleLineFormat
  118. logMessageFormat= net.ittimeline.mybatis.practices.core.CustomizeLineFormat

  120. # format that is used for logging of the date/time/... (has to be compatible with java.text.SimpleDateFormat)
  121. # (default is dd-MMM-yy)
  122. databaseDialectDateFormat=yyyy-MM-dd HH:mm:ss

  124. # sets the date format using Java's SimpleDateFormat routine.
  125. # In case property is not set, miliseconds since 1.1.1970 (unix time) is used (default is empty)
  126. #dateformat=
  127. dateformat=yyyy-MM-dd HH:mm:ss

  129. # whether to expose options via JMX or not
  130. # (default is true)
  131. #jmx=true

  133. # if exposing options via jmx (see option: jmx), what should be the prefix used?
  134. # jmx naming pattern constructed is: com.p6spy(.<jmxprefix>)?:name=<optionsclassname>
  135. # please note, if there is already such a name in use it would b
  136. e unregistered first (the last registered wins)
  137. # (default is none)
  138. #jmxPrefix=

  140. #################################################################
  141. # DataSource replacement                                        #
  142. #                                                               #
  143. # Replace the real DataSource class in your application server  #
  144. # configuration with the name com.p6spy.engine.spy.P6DataSource #
  145. # (that provides also connection pooling and xa support).       #
  146. # then add the JNDI name and class name of the real             #
  147. # DataSource here                                               #
  148. #                                                               #
  149. # Values set in this item cannot be reloaded using the          #
  150. # reloadproperties variable. Once it is loaded, it remains      #
  151. # in memory until the application is restarted.                 #
  152. #                                                               #
  153. #################################################################
  154. #realdatasource=/RealMySqlDS
  155. #realdatasourceclass=com.mysql.jdbc.jdbc2.optional.MysqlDataSource

  157. #################################################################
  158. # DataSource properties                                         #
  159. #                                                               #
  160. # If you are using the DataSource support to intercept calls    #
  161. # to a DataSource that requires properties for proper setup,    #
  162. # define those properties here. Use name value pairs, separate  #
  163. # the name and value with a semicolon, and separate the         #
  164. # pairs with commas.                                            #
  165. #                                                               #
  166. # The example shown here is for mysql                           #
  167. #                                                               #
  168. #################################################################
  169. #realdatasourceproperties=port;3306,serverName;myhost,databaseName;jbossdb,foo;bar

  171. #################################################################
  172. # JNDI DataSource lookup                                        #
  173. #                                                               #
  174. # If you are using the DataSource support outside of an app     #
  175. # server, you will probably need to define the JNDI Context     #
  176. # environment.                                                  #
  177. #                                                               #
  178. # If the P6Spy code will be executing inside an app server then #
  179. # do not use these properties, and the DataSource lookup will   #
  180. # use the naming context defined by the app server.             #
  181. #                                                               #
  182. # The two standard elements of the naming environment are       #
  183. # jndicontextfactory and jndicontextproviderurl. If you need    #
  184. # additional elements, use the jndicontextcustom property.      #
  185. # You can define multiple properties in jndicontextcustom,      #
  186. # in name value pairs. Separate the name and value with a       #
  187. # semicolon, and separate the pairs with commas.                #
  188. #                                                               #
  189. # The example shown here is for a standalone program running on #
  190. # a machine that is also running JBoss, so the JDNI context     #
  191. # is configured for JBoss (3.0.4).                              #
  192. #                                                               #
  193. # (by default all these are empty)                              #
  194. #################################################################
  195. #jndicontextfactory=org.jnp.interfaces.NamingContextFactory
  196. #jndicontextproviderurl=localhost:1099
  197. #jndicontextcustom=java.naming.factory.url.pkgs;org.jboss.nameing:org.jnp.interfaces

  199. #jndicontextfactory=com.ibm.websphere.naming.WsnInitialContextFactory
  200. #jndicontextproviderurl=iiop://localhost:900

  202. ################################################################
  203. # P6 LOGGING SPECIFIC PROPERTIES                               #
  204. ################################################################

  206. # filter what is logged
  207. # please note this is a precondition for usage of: include/exclude/sqlexpression
  208. # (default is false)
  209. #filter=false

  211. # comma separated list of strings to include
  212. # please note that special characters escaping (used in java)
  213. has to be done for the provided regular expression
  214. # (default is empty)
  215. #include =
  216. # comma separated list of strings to exclude
  217. # (default is empty)
  218. #exclude =

  220. # sql expression to evaluate if using regex
  221. # please note that special characters escaping (used in java) has
  222. to be done for the provided regular expression
  223. # (default is empty)
  224. #sqlexpression =

  226. #list of categories to exclude: error, info, batch, debug, statement,
  227. #commit, rollback and result are valid values
  228. # (default is info,debug,result,resultset,batch)
  229. #excludecategories=info,debug,result,resultset,batch

  231. # Execution threshold applies to the standard logging of P6Spy.
  232. # While the standard logging logs out every statement
  233. # regardless of its execution time, this feature puts a time
  234. # condition on that logging. Only statements that have taken
  235. # longer than the time specified (in milliseconds) will be
  236. # logged. This way it is possible to see only statements that
  237. # have exceeded some high water mark.
  238. # This time is reloadable.
  239. #
  240. # executionThreshold=integer time (milliseconds)
  241. # (default is 0)
  242. #executionThreshold=

  244. ################################################################
  245. # P6 OUTAGE SPECIFIC PROPERTIES                                #
  246. ################################################################
  247. # Outage Detection
  248. #
  249. # This feature detects long-running statements that may be indicative of
  250. # a database outage problem. If this feature is turned on, it will log any
  251. # statement that surpasses the configurable time boundary during its execution.
  252. # When this feature is enabled, no other statements are logged except the long
  253. # running statements. The interval property is the boundary time set in seconds.
  254. # For example, if this is set to 2, then any statement requiring at least 2
  255. # seconds will be logged. Note that the same statement will continue to be logged
  256. # for as long as it executes. So if the interval is set to 2, and the query takes
  257. # 11 seconds, it will be logged 5 times (at the 2, 4, 6, 8, 10 second intervals).
  258. #
  259. # outagedetection=true|false
  260. # outagedetectioninterval=integer time (seconds)
  261. #
  262. # (default is false)
  263. #outagedetection=false
  264. # (default is 60)
  265. #outagedetectioninterval=30</optionsclassname></jmxprefix>
复制代码


二 MyBatis集成P6spy

MyBatis集成P6spy，这里倒不如说成DataSource集成P6Spy更贴切，
这里增加一个名为database.properties的文件，内容如下

  1. jdbc.driver=com.p6spy.engine.spy.P6SpyDriver
  2. jdbc.url=jdbc:p6spy:mysql://127.0.0.1:3306/mybatis?useUnicode=
  3. true&characterEncoding=UTF-8&useSSL=false
  4. jdbc.username=root
  5. jdbc.password=guanglei
复制代码

主要包含了数据库的连接信息，和之前的配置不同的是更换了驱动实现以及数据库连接地址。
而mybatis-config.xml文件中只需要增加一行配置，然后就可以采用${属性名}的方式获取数据库配置了，
配置如下所示

  1. <!--?xml version="1.0" encoding="UTF-8" ?-->
  2. <configuration>
  3.     <properties resource="database.properties"
  4.     <!--配置数据库连接信息 -->
  5.     <environments default="development">
  6.         <environment id="development">
  7.             <transactionmanager type="JDBC"></transactionmanager>
  8.             <datasource type="POOLED">
  9.                 <property name="driver" value="${jdbc.driver}">
  10.                 <property name="url" value="${jdbc.url}">
  11.                 <property name="username" value="${jdbc.username}">
  12.                 <property name="password" value="${jdbc.password}">
  13.             </property></property></property></property></datasource>
  14.         </environment>
  15.     </environments>
  16. </properties></configuration>
复制代码


然后运行ContryMapperTest.selectAll()方法，会发现在模块的根路径下
存在一个mybatis-practices-core.log的文件，内容如下

  1. 当前时间:2018-01-30 23:03:07 SQL执行耗时(毫秒)为0 SQL执行的语句是
  2. SELECT country_id AS countryId, country_name AS countryName, country_code AS countryCode
  3. FROM t_country
复制代码



回复

举报

返回列表 发新帖
高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 注册

本版积分规则

手机版|小黑屋|VIP|电脑疯子技术论坛 ( Computer madman team )

GMT+8, 2025-2-2 20:36

Powered by Discuz! X3.4

Copyright © 2001-2023, Tencent Cloud.

快速回复 返回顶部 返回列表