Hibernate学习笔记一

在普通java应用中使用Hibernate。

代码参考自Hibernate的官方网站中文教程

http://docs.jboss.org/hibernate/core/3.6/reference/zh-CN/html/tutorial.html

一、安装JDK 6、Eclipse、Maven 2和m2e

JDK 6

http://www.oracle.com/technetwork/java/javase/downloads/index.html

Eclipse Java EE

http://www.eclipse.org/

Apache Maven 2.2.1

http://maven.apache.org/

Maven Integration (M2E)

http://www.eclipse.org/m2e/

（关于m2e的安装问题，见另一篇日志《Maven学习记录》）

二、安装hsqldb

(1) 下载hsqldb_1_8_1_3.zip，创建新的文件夹hsqldb。

解压hsqldb.jar放在hsqldb文件夹中。

(2) 创建批处理startdb.bat（可以指定java.exe的完整路径，用引号括起）

内容如下：

"D:\java\jdk1.6.0_20\bin\java.exe" -cp hsqldb.jar org.hsqldb.Server

(3) 创建server.properties，内容如下：

server.database.0=file:test/test

server.dbname.0=test

server.port=9001

server.silent=true

server.trace=false

(4) 双击startdb.bat，自动生成test目录，并启动数据库（控制台不退出）。

开始监听9001端口（不要开多个实例以避免端口冲突）

如果测试结束可按Ctrl+C关闭数据库。

三、创建工程

New->Other->Maven Project->

Next->Filter:填maven-archetype-quickstart并选中->

Next->Group Id:填org.hibernate.tutorial->

Artifact Id:填hibernate-tutorial->

Package:填org.hibernate.tutorial->

Finish

四、修改编码格式

右键->Properties->Resource->Text file encoding->

Other填UTF-8。

修改完后m2e会自动更新pom.xml的内容

五、更改pom.xml

把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>org.hibernate.tutorial</groupId>
  <artifactId>hibernate-tutorial</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>hibernate-tutorial</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>


  <!-- 上面的pom.xml片段都是用下面命令行自动生成的，并且创建了目录结构（不包括src/main/resources） -->
  <!-- 
       mvn archetype:generate 
           -DgroupId=org.hibernate.tutorial 
           -DartifactId=hibernate-tutorial 
           -DarchetypeArtifactId=maven-archetype-quickstart 
           -DinteractiveMode=false
    -->

  <!-- we dont want the version to be part of the generated war file name -->
  <!-- 我们不想让生成的war文件名中包含版本号 -->
  <!--
  <build>
    <finalName>${artifactId}</finalName>
  </build>
    -->
  
  <!-- 关闭警告 -->
  <!--
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
    -->
  
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
    
    
    <!-- 依赖的关键字搜索在http://www.mvnbrowser.com/index.html，输入相应的库名，如hibernate-core -->
    <!-- maven的搜索引擎请参考http://maven.apache.org/general.html -->
	<dependency>
	  <groupId>org.hibernate</groupId>
	  <artifactId>hibernate-core</artifactId>
	  <version>3.3.2.GA</version>
	</dependency>
	<!-- Because this is a web app, we also have a dependency on the servlet api. -->
	<!-- 因为这是个web应用，我们也有一个对servlet api的依赖。 -->
	<dependency>
	  <groupId>javax.servlet</groupId>
	  <artifactId>servlet-api</artifactId>
	  <version>2.5</version>
	</dependency>
	<!-- Hibernate uses slf4j for logging, for our purposes here use the simple backend -->
	<!-- Hibernate使用slf4j输出日志，这里我们只使用简单后端 -->
	<dependency>
	  <groupId>org.slf4j</groupId>
	  <artifactId>slf4j-simple</artifactId>
	  <version>1.5.6</version>
	</dependency>
	<!-- Hibernate gives you a choice of bytecode providers between cglib and javassist -->
	<!-- Hibernate让你可以选择bytecode提供者是cglib还是javassist -->
	<dependency>
	  <groupId>javassist</groupId>
	  <artifactId>javassist</artifactId>
	  <version>3.10.0.GA</version>
	</dependency>
	<dependency>
	  <groupId>hsqldb</groupId>
	  <artifactId>hsqldb</artifactId>
	  <version>1.8.0.1</version>
	</dependency>
  </dependencies>
  
  <!-- see http://maven.apache.org/plugins/maven-resources-plugin/examples/encoding.html-->
  <build>
   <!-- 资源 -->
   <!-- 保留所有.hbm.xml文件 -->
   <resources>
	<resource>
	 <filtering>false</filtering>
	 <directory>src/main/java</directory>
	 <includes>
	 <include>**/*.hbm.xml</include>
	 </includes>
    </resource>
	<!-- 保留resources下的所有文件 -->
	<resource>
	 <filtering>false</filtering>
	 <directory>src/main/resources</directory>
	 <includes>
	 <include>**/*</include>
	 </includes>
    </resource>
   </resources>
   
   <!-- 资源和编译器插件，参数设置方法见http://maven.apache.org/plugins/index.html -->
   <plugins>
    <!-- 资源插件，使用UTF-8编码 -->
    <plugin>
	  <groupId>org.apache.maven.plugins</groupId>  
	  <artifactId>maven-resources-plugin</artifactId>
	  <version>2.5</version>
	  <configuration>  
	    <encoding>UTF-8</encoding>  
	  </configuration>  
    </plugin>
    <!-- 编译器插件，使用JDK1.6，使用UTF-8编码 -->
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>2.3.2</version>
      <configuration>
        <source>1.5</source>
        <target>1.5</target>
        <encoding>UTF-8</encoding>
      </configuration>
    </plugin>
    <!-- 执行插件的java任务，参数设置方法见http://mojo.codehaus.org/exec-maven-plugin/usage.html-->
    <!-- 指定java主类和参数，用于测试 -->
    <!-- mvn clean compile后执行mvn exec:java --> 
    <!-- 如果执行命令行，则为 -->
    <!-- mvn exec:java -Dexec.mainClass="org.hibernate.tutorial.EventManager" -Dexec.args="store" -->
    <plugin>
      <groupId>org.codehaus.mojo</groupId>
      <artifactId>exec-maven-plugin</artifactId>
      <version>1.2</version>
      <executions>
        <execution>
          <goals>
            <goal>java</goal>
          </goals>
        </execution>
      </executions>
      <configuration>
        <mainClass>org.hibernate.tutorial.EventManager</mainClass>
        <arguments>
          <argument>store</argument>
        </arguments>
        <!--
        <systemProperties>
          <systemProperty>
            <key>myproperty</key>
            <value>myvalue</value>
          </systemProperty>
        </systemProperties>
        -->
      </configuration>
    </plugin>
   </plugins>
  </build>
</project>

其中涉及如下问题：

(1)需要手工到网上查询依赖的版本号

(2)需要设置src/main/java和src/main/resources的过滤策略

(3)需要设置一些插件参数以支持UTF-8和方便测试

六、编写Java类

（参考自：http://docs.jboss.org/hibernate/core/3.6/reference/zh-CN/html/tutorial.html）

src\main\java\org\hibernate\tutorial\EventManager.java

package org.hibernate.tutorial;

import java.util.*;
import org.hibernate.Session;
import org.hibernate.tutorial.domain.Event;
import org.hibernate.tutorial.util.HibernateUtil;

public class EventManager {
    public static void main(String[] args) {
        EventManager mgr = new EventManager();
		System.out.println("参数是" + args[0]);
        if (args[0].equals("store")) {
            mgr.createAndStoreEvent("My Event", new Date());
        } else if (args[0].equals("list")) {
            List events = mgr.listEvents();
            for (int i = 0; i < events.size(); i++) {
                Event theEvent = (Event) events.get(i);
                System.out.println(
					"Event: " + theEvent.getTitle() +
					" Time: " + theEvent.getDate());
            }
        }
        HibernateUtil.getSessionFactory().close();
    }

    private void createAndStoreEvent(String title, Date theDate) {
        Session session = HibernateUtil.getSessionFactory().getCurrentSession();
        session.beginTransaction();
        Event theEvent = new Event();
        theEvent.setTitle(title);
        theEvent.setDate(theDate);
        session.save(theEvent);
        session.getTransaction().commit();
    }

    private List listEvents() {
        Session session = HibernateUtil.getSessionFactory().getCurrentSession();
        session.beginTransaction();
        List result = session.createQuery("from Event").list();
        session.getTransaction().commit();
        return result;
    }
}

src\main\java\org\hibernate\tutorial\util\HibernateUtil.java

package org.hibernate.tutorial.util;

import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;

public class HibernateUtil {
    private static final SessionFactory sessionFactory = buildSessionFactory();

    private static SessionFactory buildSessionFactory() {
        try {
            // Create the SessionFactory from hibernate.cfg.xml
            // 从hibernate.cfg.xml中创建SessionFactory
            return new Configuration().configure().buildSessionFactory();
        } catch (Throwable ex) {
            // Make sure you log the exception, as it might be swallowed
            // 当它可能被吞食时，保证你的异常被记录到日志中
            System.err.println("Initial SessionFactory creation failed." + ex);
            throw new ExceptionInInitializerError(ex);
        }
    }

    public static SessionFactory getSessionFactory() {
        return sessionFactory;
    }
}

src\main\java\org\hibernate\tutorial\domain\Event.java

package org.hibernate.tutorial.domain;

import java.util.Date;

public class Event {
    private Long id;

    private String title;
    private Date date;

    public Event() {}

    public Long getId() {
        return id;
    }

    private void setId(Long id) {
        this.id = id;
    }

    public Date getDate() {
        return date;
    }

    public void setDate(Date date) {
        this.date = date;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }
}

七、编写.cfg.xml和.hbm.xml配置文件

（参考自：http://docs.jboss.org/hibernate/core/3.6/reference/zh-CN/html/tutorial.html）

创建src/main/resources目录

src\main\resources\hibernate.cfg.xml

<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE hibernate-configuration PUBLIC
    "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
    "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
    <session-factory>
        <!-- Database connection settings -->
        <!-- 数据库连接设置 -->
        <property name="connection.driver_class">org.hsqldb.jdbcDriver</property>
        <property name="connection.url">jdbc:hsqldb:hsql://localhost:9001/test</property>
        <property name="connection.username">sa</property>
        <property name="connection.password"></property>

        <!-- JDBC connection pool (use the built-in) -->
        <!-- JDBC连接池（使用内置）-->
        <property name="connection.pool_size">1</property>

        <!-- SQL dialect -->
        <!-- SQL方言 -->
        <property name="dialect">org.hibernate.dialect.HSQLDialect</property>

        <!-- Enable Hibernate's automatic session context management -->
        <!-- 开启Hibernate的自动上下文管理 -->
        <property name="current_session_context_class">thread</property>

        <!-- Disable the second-level cache  -->
        <!-- 关闭二级缓存 -->
        <property name="cache.provider_class">org.hibernate.cache.NoCacheProvider</property>

        <!-- Echo all executed SQL to stdout -->
        <!-- 输出所有执行SQL到stdout -->
        <property name="show_sql">true</property>

        <!-- Drop and re-create the database schema on startup -->
        <!-- 在启动时卸载并重新创建数据库 -->
        <property name="hbm2ddl.auto">update</property>
        <mapping resource="org/hibernate/tutorial/domain/Event.hbm.xml"/>
    </session-factory>
</hibernate-configuration>

src\main\java\org\hibernate\tutorial\domain\Event.hbm.xml

<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC
    "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
    "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd">
<hibernate-mapping package="org.hibernate.tutorial.domain">
    <class name="Event" table="EVENTS">
        <id name="id" column="EVENT_ID">
			<generator class="native"/>
        </id>
        <property name="date" type="timestamp" column="EVENT_DATE"/>
        <property name="title"/>
    </class>
</hibernate-mapping>

八、编译运行

工程->右键->Debug As->Maven package

如果显示BUILD SUCCESS

你会看到

/hibernate-tutorial/target/hibernate-tutorial-0.0.1-SNAPSHOT.jar

这个jar文件

然后启动第二步提到的hsqldb，双击startdb.bat

工程->右键->Debug As->Maven build...->Goals->exec:java

（因为我已经在pom.xml定义了参数，所以下面不用添加参数）

按Run运行

显示以下内容

如果把pom.xml中的参数store改为list，运行结果中显示刚才插入数据的时间