jodd.db.debug.LoggablePreparedStatementFactory Maven / Gradle / Ivy
// Copyright (c) 2003-present, Jodd Team (http://jodd.org)
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
package jodd.db.debug;
import jodd.db.DbSqlException;
import jodd.proxetta.MethodInfo;
import jodd.proxetta.ProxyAspect;
import jodd.proxetta.asm.ProxettaAsmUtil;
import jodd.proxetta.impl.WrapperProxettaBuilder;
import jodd.proxetta.impl.WrapperProxetta;
import jodd.proxetta.pointcuts.ProxyPointcutSupport;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.util.concurrent.locks.ReentrantLock;
/**
* Factory for loggable prepared statements - a PreparedStatement with added logging capability.
*
* In addition to the methods declared in PreparedStatement,
* LoggablePreparedStatement provides a method {@link #getQueryString} that can be used to get
* the query string in a format suitable for logging.
*
* Should not be used in production!
*/
@SuppressWarnings("MagicConstant")
public class LoggablePreparedStatementFactory {
public static PreparedStatement create(Connection connection, String sql) throws SQLException {
PreparedStatement preparedStatement = connection.prepareStatement(sql);
return wrap(preparedStatement, sql);
}
public static PreparedStatement create(Connection connection, String sql, int resultSetType, int resultSetConcurrency) throws SQLException {
PreparedStatement preparedStatement = connection.prepareStatement(sql, resultSetType, resultSetConcurrency);
return wrap(preparedStatement, sql);
}
public static PreparedStatement create(Connection connection, String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException {
PreparedStatement preparedStatement = connection.prepareStatement(sql, resultSetType, resultSetConcurrency, resultSetHoldability);
return wrap(preparedStatement, sql);
}
public static PreparedStatement create(Connection connection, String sql, int autoGeneratedKeys) throws SQLException {
PreparedStatement preparedStatement = connection.prepareStatement(sql, autoGeneratedKeys);
return wrap(preparedStatement, sql);
}
public static PreparedStatement create(Connection connection, String sql, int[] columnIndexes) throws SQLException {
PreparedStatement preparedStatement = connection.prepareStatement(sql, columnIndexes);
return wrap(preparedStatement, sql);
}
public static PreparedStatement create(Connection connection, String sql, String[] columnNames) throws SQLException {
PreparedStatement preparedStatement = connection.prepareStatement(sql, columnNames);
return wrap(preparedStatement, sql);
}
// ---------------------------------------------------------------- wrap
protected static Class wrappedPreparedStatement;
protected static WrapperProxettaBuilder builder;
protected static Field sqlTemplateField;
protected static Method getQueryStringMethod;
protected static WrapperProxetta proxetta;
private static final ReentrantLock lock = new ReentrantLock();
/**
* Returns {@link WrapperProxetta} used for building loggable prepared statements.
* Initializes proxetta when called for the first time.
*/
public static WrapperProxetta getProxetta() {
if (proxetta == null) {
proxetta = WrapperProxetta.withAspects(new ProxyAspect(LoggableAdvice.class, new ProxyPointcutSupport() {
public boolean apply(MethodInfo methodInfo) {
int argumentsCount = methodInfo.getArgumentsCount();
char argumentType = 0;
if (argumentsCount >= 1) {
argumentType = methodInfo.getArgumentOpcodeType(1);
}
return
methodInfo.getReturnOpcodeType() == 'V' && // void-returning method
argumentType == 'I' && // first argument type
methodInfo.isTopLevelMethod() && // top-level
methodInfo.getMethodName().startsWith("set") && // set*
(argumentsCount == 2 || argumentsCount == 3); // number of arguments
}
}));
}
return proxetta;
}
/**
* Wraps prepared statement.
*/
@SuppressWarnings("unchecked")
protected static PreparedStatement wrap(PreparedStatement preparedStatement, String sql) {
if (wrappedPreparedStatement == null) {
lock.lock();
try {
if (wrappedPreparedStatement == null) {
proxetta = getProxetta();
builder = proxetta.builder();
// use just interface
builder.setTarget(PreparedStatement.class);
// define different package
builder.setTargetProxyClassName(LoggablePreparedStatementFactory.class.getPackage().getName() + '.');
wrappedPreparedStatement = builder.define();
// lookup fields
try {
String fieldName = ProxettaAsmUtil.adviceFieldName("sqlTemplate", 0);
sqlTemplateField = wrappedPreparedStatement.getField(fieldName);
String methodName = ProxettaAsmUtil.adviceMethodName("getQueryString", 0);
getQueryStringMethod = wrappedPreparedStatement.getMethod(methodName);
} catch (Exception ex) {
throw new DbSqlException(ex);
}
}
}
finally {
lock.unlock();
}
}
// wrap prepared statement instance
PreparedStatement wrapper;
try {
wrapper = wrappedPreparedStatement.newInstance();
} catch (Exception ex) {
throw new DbSqlException(ex);
}
builder.injectTargetIntoWrapper(preparedStatement, wrapper);
try {
sqlTemplateField.set(wrapper, sql);
} catch (Exception ex) {
throw new DbSqlException(ex);
}
return wrapper;
}
/**
* Returns the query string from loggable prepared statement.
*/
public static String getQueryString(PreparedStatement preparedStatement) {
try {
return (String) getQueryStringMethod.invoke(preparedStatement);
} catch (Exception ex) {
throw new DbSqlException(ex);
}
}
}