备忘：hibernate, logback, slf4j实际应用一例

用hibernate写一些简单的数据库的Java应用。主要是温习一下。之前弄过的一些都忘了。发现还是得记下来，不然很快就忘。

1. Eclipse版本，用Juno, J2EE版本。最好下载zip版本的，直接解压就运行。

2. JDK安装，到Oracle上搜索jdk, 然后下载。安装JDK后，设置JAVA_HOME，指到JDK安装目录，将%JAVA_HOME%\bin放到PATH变量的最前面。

3. Maven。到Eclipse marketplace上搜索maven, 会有一个Maven Integration for Eclipse (Juno or newer), by Eclipse.org, 安装它。它里面有maven。

4. Jboss tools. 到Eclipse marketplace上搜索jboss tools，会有一个jboss tools (Juno), by Red hat Inc. 安装它。它里面有hibernate tools, 当然也有别的工具。暂时是只用hibernate tools。

5. 根据数据库来生成hibernate的类文件或者hbm.xml，cfg.xml等。

Windows->Open Perspectives->Other, 然后选hibernate perspective，然后鼠标右键点击左边的hibernate Configurations窗口，出来一个弹出菜单，选Add Configuration。如图：

之后出现这个窗口：

如果没有配置数据库连接就New一个，如果已经有的话就选择一个。Configuration file没有的话就Setup一个。

在这个hibernate视图里有一个Hibernate Code Generation 按钮。如图：

当然了，在Run菜单里也有一个。Run-> Hibernate Code Generation->Hibernate Code Generation Config。如图:

之后是这样的配置窗口：

在Console configuration那里选择之前建立的Console configuration。再输入package name等。点击Exporters Tab.

如果你想用Entity class加*.hbm.xml文件的方式，那就去掉Generate EJB3 annotation的钩，并勾上hbm.xml和cfg.xml的选项。现在这样的选择是采用，有EJB3 annotation的class和cfg.xml就可以了。相对比较简洁和漂亮。所以就这样了。

这个Hibernate code generation的配置建立好了。随后运行它。然后就在我们刚指定的路径里产生了多个java文件。

这是其中一个类：

看到没有，Id字段有EJB3的annotation. 其他的字段也有。

之后我们要将pom.xml文件准备好。

<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>mymaven</groupId>
  <artifactId>mymaven</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <dependencies>
      <dependency>
          <groupId>org.hibernate</groupId>
          <artifactId>hibernate</artifactId>
          <version>3.5.4-Final</version>
          <type>pom</type>
      </dependency>
      <dependency>
          <groupId>org.hibernate</groupId>
          <artifactId>hibernate-annotations</artifactId>
          <version>3.5.4-Final</version>
      </dependency>
      <dependency>
          <groupId>org.hibernate</groupId>
          <artifactId>hibernate-core</artifactId>
          <version>3.5.4-Final</version>
      </dependency>
      <dependency>
          <groupId>org.javassist</groupId>
          <artifactId>javassist</artifactId>
          <version>3.18.2-GA</version>
      </dependency>
      <dependency>
          <groupId>org.slf4j</groupId>
          <artifactId>slf4j-api</artifactId>
          <version>1.7.7</version>
      </dependency>
      <dependency>
          <groupId>ch.qos.logback</groupId>
          <artifactId>logback-classic</artifactId>
          <version>1.1.2</version>
      </dependency>
      <dependency>
          <groupId>ch.qos.logback</groupId>
          <artifactId>logback-core</artifactId>
          <version>1.1.2</version>
      </dependency>
      <dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
          <version>5.1.31</version>
      </dependency>
  </dependencies>
</project>

这里得说javassist必须得要。hibernate需要这个库。要不就会出错。那个错误是说不能初始化PojoTuplizer的实例。找了本人好久啊。别的库也都是要的。
既然用了logback，就要一个logback.xml:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="c:/log" />
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
       <!-- 日志输出编码 -->
       <Encoding>UTF-8</Encoding>
        <layout class="ch.qos.logback.classic.PatternLayout">
             <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
        </layout>
    </appender>
    <!-- 按照每天生成日志文件 -->
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <Encoding>UTF-8</Encoding>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/myApp.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
       </layout>
        <!--日志文件最大的大小-->
       <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
         <MaxFileSize>10MB</MaxFileSize>
       </triggeringPolicy>
    </appender>
   <!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder"  level="TRACE" />
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor"  level="DEBUG" />
    <logger name="org.hibernate.SQL" level="DEBUG" />
    <logger name="org.hibernate.type" level="TRACE" />
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />  

    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root> 

     <!--日志异步到数据库 -->
    <!-- <appender name="DB" class="ch.qos.logback.classic.db.DBAppender">
        <connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">
           <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">
              <driverClass>com.mysql.jdbc.Driver</driverClass>
              <url>jdbc:mysql://127.0.0.1:3306/databaseName</url>
              <user>root</user>
              <password>root</password>
            </dataSource>
        </connectionSource>
  </appender> -->
</configuration>

这里说明一下。在别的网络文章能找到别的配置项，却没有这个：

<logger name="org.hibernate.type" level="TRACE" />

加上这个才真正能让SQL 中的参数被打印出来。仅有其余的设置没有用。

这里有一些log:

2014-06-23 21:47:01.748 [main] INFO  org.hibernate.impl.SessionFactoryObjectFactory - Not binding factory to JNDI, no JNDI name configured
2014-06-23 21:47:01.787 [main] DEBUG org.hibernate.SQL -
    select
        category0_.CategoryId as CategoryId5_0_,
        category0_.CategoryName as Category2_5_0_,
        category0_.ParentCategoryId as ParentCa3_5_0_,
        category0_.ShortName as ShortName5_0_
    from
        mikelij.category category0_
    where
        category0_.CategoryId=?
Hibernate:
    select
        category0_.CategoryId as CategoryId5_0_,
        category0_.CategoryName as Category2_5_0_,
        category0_.ParentCategoryId as ParentCa3_5_0_,
        category0_.ShortName as ShortName5_0_
    from
        mikelij.category category0_
    where
        category0_.CategoryId=?
2014-06-23 21:47:01.800 [main] TRACE org.hibernate.type.IntegerType - binding '5' to parameter: 1
2014-06-23 21:47:01.806 [main] TRACE org.hibernate.type.StringType - returning '情感' as column: Category2_5_0_
2014-06-23 21:47:01.806 [main] TRACE org.hibernate.type.IntegerType - returning '5' as column: ParentCa3_5_0_
2014-06-23 21:47:01.806 [main] TRACE org.hibernate.type.StringType - returning 'qinggan' as column: ShortName5_0_
2014-06-23 21:47:01.809 [main] INFO  org.nf.myfirst - Found
2014-06-23 21:47:01.816 [main] INFO  org.nf.myfirst - End

看到没有：binding '5' to parameter: 1， 这是SQL的输入参数。后面几个是返回的字段值。

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE hibernate-configuration PUBLIC
"-//Hibernate/Hibernate Configuration DTD 3.0//EN"
"http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
    <session-factory>
        <property name="show_sql">true</property>
        <property name="format_sql">true</property>
        <property name="connection.release_mode">on_close</property>
        <property name="transaction.auto_close_session">false</property>
        <property name="connection.autocommit">false</property>
        <property name="hibernate.bytecode.use_reflection_optimizer">false</property>
        <property name="hibernate.connection.driver_class">com.mysql.jdbc.Driver</property>
        <property name="hibernate.connection.password">dddd</property>
        <property name="hibernate.connection.url">jdbc:mysql://localhost:3306/mikelij</property>
        <property name="hibernate.connection.username">root</property>
        <property name="hibernate.dialect">org.hibernate.dialect.MySQLDialect</property>
        <property name="hibernate.search.autoregister_listeners">false</property>
        <property name="hibernate.current_session_context_class">thread</property>
        <mapping class="org.nf.model.Sensitivekeyword" />
        <mapping class="org.nf.model.Comment" />
        <mapping class="org.nf.model.Group" />
        <mapping class="org.nf.model.Post" />
        <mapping class="org.nf.model.User" />
        <mapping class="org.nf.model.Category" />
        <mapping class="org.nf.model.Message" />
    </session-factory>
</hibernate-configuration>

这里的说明比较多。首先mapping 都是用mapping class来配置hibernate的。如果是hbm.xml，那么就是用的mapping 文件来做的。
另外这句<property name="hibernate.current_session_context_class">thread</property>是为了Java application准备的。它没有JNDI环境。不象有Tomcat那样的容器，默认提供了一个JNDI环境。所以Java application，这个context的class就得这个设置。不过，如果是Spring，就得用Spring提供的Context class。

<property name="show_sql">true</property>
        <property name="format_sql">true</property>
        <property name="connection.release_mode">on_close</property>
        <property name="transaction.auto_close_session">false</property>
        <property name="connection.autocommit">false</property>

这几句是为了显示sql和格式化sql。另外是为了让Session不自动close。不自动提交。

现在这里是Java代码：

package org.nf;
import org.hibernate.*;
import org.hibernate.cfg.*;
import org.nf.model.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class myfirst {

    /**
     * @param args
     */
    public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(myfirst.class);
        logger.info("Start");
        Configuration config = new AnnotationConfiguration();
        config.configure();
        SessionFactory factory = config.buildSessionFactory();
        Session session = factory.openSession();
        Transaction transaction = session.beginTransaction();
        Category category = (Category) session.get(Category.class, 5);
        if (category.getCategoryName() != "")
             logger.info("Found");
        transaction.commit();
        session.close();
        logger.info("End");
    }

}

因为用的是Annotation，所以用的是AnnotationConfiguration类。factory的openSession和openCurrentSession方法有一个区别。openCurrentSession得到的Session会被Transaction.Commit自动关闭Session。而openSession得到的Session不会因为Transaction.Commit而自动关闭。所以可以建立另外一个Transaction。连接还是同一个。没有关闭过。这个有什么用吗？当然有用，当有大批量数据操作的时候，可以提交一部分到数据库去处理，然后继续后续的数据处理。这样可以提高整个大批量数据的数据处理速度。

logback.xml和hibernate.cfg.xml都是属于资源文件。在maven中，默认把这类字段文件放到src/main/resources目录下最好:

如果是测试工程的资源文件，可以放在src/test/resources目录下。