使mybatis实现根据输入值是否为空进行动态组合查询条件

mingche

一直想让mybatis实现根据传入的DTO对象的值来自由组合查询条件。例如：查询语句
select deptno,dname,loc from dept where deptno=? and dname=? and loc=?。如果我传入的DTO只有deptno和dname两个属性值。系统能自动将查询SQL修改为
select deptno,dname,loc from dept where deptno=? and dname=?。虽然通过mybatis的动态SQL可以实现。但是要写的代码太多，而且每个使用SQL都要进行修改，过于麻烦。所以就想通过修改mybatis的代码来实现此种功能。来简化开发代码编写量，提高开发效率.
     经过几天的代码追踪，最后通过以下的代码调整，实现以上功能。
设置SQL的类，由于mybatis是在
org.apache.ibatis.executor.statement.PreparedStatementHandler类的
instantiateStatement方法中获取sql
protected Statement instantiateStatement(Connection connection) throws SQLException {
    String sql = boundSql.getSql();
所以就想在此处进行sql重新设置。
顾在此处增加
  sql=parameterHandler.setSQL(sql);
重新设置SQL
由于ParameterHandler是一个接口。所以在
org.apache.ibatis.executor.parameter.ParameterHandler
接口中增加getSql方法
  String setSQL(String sql) throws SQLException;
由于org.apache.ibatis.executor.parameter.DefaultParameterHandler实现了ParameterHandler接口
所以在DefaultParameterHandler类中增加设置SQL的方法。
  //更新SQL
  public String setSQL(String sql) throws SQLException {
  String tempString="";
  int tempInt=0;
ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());
List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
if (parameterMappings != null) {
  MetaObject metaObject = parameterObject == null ? null : configuration.newMetaObject(parameterObject);
  for (int i = 0; i < parameterMappings.size(); i++) {
    ParameterMapping parameterMapping = parameterMappings.get(i);
    if (parameterMapping.getMode() != ParameterMode.OUT) {
      Object value;
      String propertyName = parameterMapping.getProperty();
      PropertyTokenizer prop = new PropertyTokenizer(propertyName);
      if (parameterObject == null) {
        value = null;
      } else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
        value = parameterObject;
      } else if (boundSql.hasAdditionalParameter(propertyName)) {
        value = boundSql.getAdditionalParameter(propertyName);
      } else if (propertyName.startsWith(ForEachSqlNode.ITEM_PREFIX)
          && boundSql.hasAdditionalParameter(prop.getName())) {
        value = boundSql.getAdditionalParameter(prop.getName());
        if (value != null) {
          value = configuration.newMetaObject(value).getValue(propertyName.substring(prop.getName().length()));
        }
      } else {
        value = metaObject == null ? null : metaObject.getValue(propertyName);
      }
      TypeHandler typeHandler = parameterMapping.getTypeHandler();
      if (typeHandler == null) {
        throw new ExecutorException("There was no TypeHandler found for parameter " + propertyName + " of statement " + mappedStatement.getId());
      }
      if(value.toString().length()==0){
  StringTokenizer parameterMappingParts = new StringTokenizer(sql,"\n\r\t");
  sql="";
while (parameterMappingParts.hasMoreTokens()) {
tempString=parameterMappingParts.nextToken();
tempInt = tempString.toUpperCase().indexOf(propertyName.toUpperCase());
if(tempInt==-1){
sql=sql+tempString+"\n\r\t";
}
}
      }
    }
  }
}
return sql;
}
此处是通过换行来进行SQL替换。
所以在XML中编写SQL时，如果哪一个查询条件要根据传入的值来判断是否保留，则需要单独一行。编写SQL如下所示：
  select * from Dept where 1=1
  DEPTNO = #{deptno}
  and DNAME = #{dname}
  and LOC = #{loc}
通过以上代码调整，mybatis就可以实现根据传入查询DTO的属性值自动进行查询SQL组合。
   
  最后，第一次写这种技术的内容，忽然发现想要把技术内容讲透彻，还真是挺麻烦的一件事。我在ITeye的第一次。值得纪念！希望能做的更好！