hibernate之hql

什么是hql

HQL是Hibernate Query Language的缩写

hql和sql区别/异同

HQL	SQL
类名/属性	表名/列名
区分大小写,关键字不区分大小写	不区分大小写
?，从下标0开始计算位置(hibernate5之后不支持)	?，从顺序1开始计算位置
:命名参数	不支持:命名参数
面向对象的查询语言	面向结构查询语言

案例展示

1. 首先大概的了解hql中的一些方法（处理返回的结果集、hql中使用占位符、 连接查询、 聚合函数、hql分页）

package com.xfz.five.test;


import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.query.Query;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import com.xfz.five.util.PageBean;
import com.xfz.four.dao.BookDao;
import com.xfz.four.entity.Book;
import com.xfz.two.util.SessionFactoryUtils;


public class HqlTest {
	private Session session;
	private Transaction transaction;
	private BookDao bookDao=new BookDao();
	
	@Before
	public void before() {
		session = SessionFactoryUtils.openSession();
		transaction = session.beginTransaction();
	}
	
	@After
	public void after() {
		transaction.commit();
		session.close();
	}
	
	/**
	 * 返回对象（多个）
	 */
	@Test
	public void testList1() {
		Query query = session.createQuery("from Book");
		List<Book> list = query.list();
		for (Book b : list) {
			System.out.println(b);
		}
	}
	
	/**
	 * 返回单个列段，用字符串就可以接受
	 */
	@Test
	public void testList2() {
		Query query = session.createQuery("select b.bookName as ss from Book b");
		List<String> list = query.list();
		for (String b : list) {
			System.out.println(b);
		}
	}
	
	/**
	 * 查两个列段及以上，默认返回的是Object【】
	 * object[]数组存放的是查出来的列段
	 */
	@Test
	public void testList3() {
		Query query = session.createQuery("select b.bookId,b.bookName as ss from Book b");
		List<Object[]> list = query.list();
		for (Object[] b : list) {
			System.out.println(Arrays.toString(b));
		}
	}
	
	/**
	 * 注意map是函数，所以不区分大小写，返回的是map集合
	 */
	@Test
	public void testList4() {
		Query query = session.createQuery("select new mAp(b.bookId,b.bookName) from Book b");
		List<Map> list = query.list();
		for (Map b : list) {
			System.out.println(b);
		}
	}
	
	/**
	 * 查两个列段及以上，也可返回对象，前提是有对应的构造函数
	 */
	@Test
	public void testList5() {
		Query query = session.createQuery("select new Book(b.bookId,b.bookName) from Book b");
		List<Book> list = query.list();
		for (Book b : list) {
			System.out.println(b);
		}
	}
	
	/**
	 * HQL语句支持占位符
	 */
	@Test
	public void testList6() {
//		Query query = session.createQuery("from Book where bookId = :bookId");
//		query.setParameter("bookId", 1);
//		Book b = (Book) query.getSingleResult();
//		System.out.println(b);
		
		//Query当做prepareStatement来用
		Query query = session.createQuery("from Book where bookId in (:bookIds)");
//		query.setParameterList("bookIds", new Integer[] {1,2,4});
		List<Integer> params = new ArrayList<Integer>();
		params.add(1);
		params.add(2);
		params.add(4);
		query.setParameterList("bookIds", params);
		List<Book> list = query.list();
		for (Book b : list) {
			System.out.println(b);
		}
	}
	
	/**
	 * HQL支持连接查询
	 */
	@Test
	public void testList7() {
		Query query = session.createQuery("select o.orderNo,oi.quantity from Order o,OrderItem oi where o = oi.order");
		List<Object[]> list = query.list();
		for (Object[] b : list) {
			System.out.println(Arrays.toString(b));
		}
	}
	
	/**
	 * HQL支持聚合函数
	 * sum
	 * count
	 * avg
	 */
	@Test
	public void testList8() {
		Query query = session.createQuery("select count(*) from Book");
		Long singleResult = (Long) query.getSingleResult();
		System.out.println(singleResult);
	}
	
	/**
	 * HQL分页
	 */
	@Test
	public void testList9() {
		Query query = session.createQuery("from Book");
		query.setFirstResult(2);
		query.setMaxResults(3);
		List<Book> list = query.list();
		for (Book b : list) {
			System.out.println(b);
		}
	}
	
	@Test
	public void testList10() {
		Book book=new Book();
		PageBean pageBean=new PageBean();
//		pageBean.setPage(2);
		book.setBookName("%圣墟%");
		List<Book> list=this.bookDao.list(book, pageBean);
		for (Book b : list) {
			System.out.println(b);
		}
	}
	
}

2. 写两个分页用的工具类
   StringUtils

package com.xfz.five.util;

public class StringUtils {
	// 私有的构造方法，保护此类不能在外部实例化
	private StringUtils() {
	}

	/**
	 * 如果字符串等于null或去空格后等于""，则返回true，否则返回false
	 * 
	 * @param s
	 * @return
	 */
	public static boolean isBlank(String s) {
		boolean b = false;
		if (null == s || s.trim().equals("")) {
			b = true;
		}
		return b;
	}
	
	/**
	 * 如果字符串不等于null或去空格后不等于""，则返回true，否则返回false
	 * 
	 * @param s
	 * @return
	 */
	public static boolean isNotBlank(String s) {
		return !isBlank(s);
	}

}

pageBean

package com.xfz.five.util;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;

/**
 * 分页工具类
 *
 */
public class PageBean {

	private int page = 1;// 页码

	private int rows = 5;// 页大小

	private int total = 0;// 总记录数

	private boolean pagination = true;// 是否分页
	// 获取前台向后台提交的所有参数
	private Map<String, String[]> parameterMap;
	// 获取上一次访问后台的url
	private String url;

	/**
	 * 初始化pagebean
	 * 
	 * @param req
	 */
	public void setRequest(HttpServletRequest req) {
		this.setPage(req.getParameter("page"));
		this.setRows(req.getParameter("rows"));
		// 只有jsp页面上填写pagination=false才是不分页
		this.setPagination(!"fasle".equals(req.getParameter("pagination")));
		this.setParameterMap(req.getParameterMap());
		this.setUrl(req.getRequestURL().toString());
	}

	public int getMaxPage() {
		return this.total % this.rows == 0 ? this.total / this.rows : this.total / this.rows + 1;
	}

	public int nextPage() {
		return this.page < this.getMaxPage() ? this.page + 1 : this.getMaxPage();
	}

	public int previousPage() {
		return this.page > 1 ? this.page - 1 : 1;
	}

	public PageBean() {
		super();
	}

	public int getPage() {
		return page;
	}

	public void setPage(int page) {
		this.page = page;
	}

	public void setPage(String page) {
		this.page = StringUtils.isBlank(page) ? this.page : Integer.valueOf(page);
	}

	public int getRows() {
		return rows;
	}

	public void setRows(int rows) {
		this.rows = rows;
	}

	public void setRows(String rows) {
		this.rows = StringUtils.isBlank(rows) ? this.rows : Integer.valueOf(rows);
	}

	public int getTotal() {
		return total;
	}

	public void setTotal(int total) {
		this.total = total;
	}

	public void setTotal(String total) {
		this.total = Integer.parseInt(total);
	}

	public boolean isPagination() {
		return pagination;
	}

	public void setPagination(boolean pagination) {
		this.pagination = pagination;
	}

	public Map<String, String[]> getParameterMap() {
		return parameterMap;
	}

	public void setParameterMap(Map<String, String[]> parameterMap) {
		this.parameterMap = parameterMap;
	}

	public String getUrl() {
		return url;
	}

	public void setUrl(String url) {
		this.url = url;
	}

	/**
	 * 获得起始记录的下标
	 * 
	 * @return
	 */
	public int getStartIndex() {
		return (this.page - 1) * this.rows;
	}

	@Override
	public String toString() {
		return "PageBean [page=" + page + ", rows=" + rows + ", total=" + total + ", pagination=" + pagination
				+ ", parameterMap=" + parameterMap + ", url=" + url + "]";
	}

}

3. 在之前所写的BookDao的基础上写入分页的方法

package com.xfz.four.dao;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.hibernate.Hibernate;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.query.Query;

import com.xfz.five.dao.BaseDao;
import com.xfz.five.util.PageBean;
import com.xfz.five.util.StringUtils;
import com.xfz.four.entity.Book;
import com.xfz.four.entity.Category;
import com.xfz.two.util.SessionFactoryUtils;




public class BookDao extends BaseDao{
	public Integer addBook(Book book) {
		Session session = SessionFactoryUtils.openSession();
		Transaction transaction = session.beginTransaction();
		Integer bid = (Integer) session.save(book);
		transaction.commit();
		session.close();
		return bid;
	}
	
	public Integer addCategory(Category category) {
		Session session = SessionFactoryUtils.openSession();
		Transaction transaction = session.beginTransaction();
		Integer cid = (Integer) session.save(category);
		transaction.commit();
		session.close();
		return cid;
	}
	
	public Category getCategory(Category category) {
		Session session = SessionFactoryUtils.openSession();
		Transaction transaction = session.beginTransaction();
		Category c = session.get(Category.class, category.getCategoryId());
		transaction.commit();
		session.close();
		return c;
	}
	
	public Book getBook(Book book) {
		Session session = SessionFactoryUtils.openSession();
		Transaction transaction = session.beginTransaction();
		Book b = session.get(Book.class, book.getBookId());
		if (b != null && new Integer(1).equals(book.getInitCategories())) {
			Hibernate.initialize(b.getCategories());
		}
		transaction.commit();
		session.close();
		return b;
	}
	
	public void delBook(Book book) {
		Session session = SessionFactoryUtils.openSession();
		Transaction transaction = session.beginTransaction();
		session.delete(book);
		transaction.commit();
		session.close();
	}
	
	public void delCategory(Category category) {
		Session session = SessionFactoryUtils.openSession();
		Transaction transaction = session.beginTransaction();
		Category c = session.get(Category.class, category.getCategoryId());
		if(c!=null) {
			for (Book b : c.getBooks()) {
//				閫氳繃鍦ㄨ鎺ф柟閫氳繃涓绘帶鏂规潵瑙ｉ櫎鍏宠仈鍏崇郴锛屾渶鍚庤鎺ф柟鍐嶅仛鍒犻櫎
				b.getCategories().remove(c);
			}
		}
		session.delete(c);
		transaction.commit();
		session.close();
	}
	
	/**
	 * @param book
	 * @param pageBean
	 * @return
	 * 书籍的分页查询
	 * 	1.动态的拼接hql语句
	 *  2.需要给拼接的hql语句的命名参数赋值（可以简化的）
	 *  3.分页（可以简化的）
	 */
	public List<Book> list(Book book,PageBean pageBean){
		Session session=SessionFactoryUtils.openSession();
//		Transaction transaction=session.beginTransaction();
		String hql="from Book where 1=1 ";
		String bname=book.getBookName();
		if(StringUtils.isNotBlank(bname)) {
			hql+=" and bookName like :bookName";
		}
		Query query=session.createQuery(hql );
		if(StringUtils.isNotBlank(bname)) {
			query.setParameter("bookName", bname);
		}
		if(pageBean!=null && pageBean.isPagination()) {
			query.setFirstResult(pageBean.getStartIndex());
			query.setMaxResults(pageBean.getRows());
		}
		List list=query.list();
//		transaction.commit();
		session.close();
		return list;
	}
	
}

4. 再写一个简化代码的BaseDao

package com.xfz.five.dao;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import org.hibernate.Session;
import org.hibernate.query.Query;

import com.xfz.five.util.PageBean;



/**
 * @author ld
 * 基于hql语句的通用查询工具类
 * 1.需要给拼接的hql语句的命名参数赋值（可以简化的）
 * 2.分页（可以简化的）
 * 
 * 基于sql的分页的查询的做法
 * 	1.首先要查询出符合条件的总记录数
 *  2.返回符合条件的记录
 *  
 *  参数：sql,pagebean,Class claz
 *  1.countSql=select count(*) from (sql) t;
 *  2.pageSql=sql+" limit "+start+","+rows
 *  
 *  基于hql的分页的查询的做法
 *   hql=from Book where bookName like "%圣墟%"
 *   hql=select * from Book where bookName like "%圣墟%"
 *   1.countHql=select count(*) hql;
 */
public class BaseDao {
	/**
	 * @param query		里面包含了带有参数的hql语句，需要等待赋值
	 * @param paramMap	
	 */
	public void setParam(Query query,Map<String, Object> paramMap) {
		if(paramMap!=null && paramMap.size()>0) {
			Set<Entry<String, Object>> entrySet=paramMap.entrySet();
			for (Entry<String, Object> entry : entrySet) {
				String key=entry.getKey();
				Object value=entry.getValue();
				if(value instanceof Object[]) {
					//value可能是数组
					query.setParameterList(key, (Object[])value);
				}else if(value instanceof Collection) {
					//value可能是集合
					query.setParameterList(key, (Collection)value);
				}else {
					//value可能是普通的字符串
					query.setParameter(key, value);
				}
			}
		}
	}
	
	/**
	 * @param hql
	 * @return
	 * 拼装符合条件的总数
	 */
	public String getCountHql(String hql) {
		int fromIndex=hql.toUpperCase().indexOf("FROM");
		return "select count(*)"+hql.substring(fromIndex);
	}
	
	/**
	 * @param hql
	 * @param pageBean
	 * @param paMap
	 * @param session
	 * @return
	 * 基于hql的通用查询方法
	 */
	public List executeQuery(String hql,PageBean pageBean,Map<String, Object> paMap,Session session) {
		List list=null;
		Query query=null;
		if(pageBean!=null && pageBean.isPagination()) {
			//查询符合条件的总记录数
			String countHql=getCountHql(hql);
			Query countQuery=session.createQuery(countHql);
			this.setParam(countQuery, paMap);
			pageBean.setTotal(countQuery.getSingleResult().toString());
			
			//返回符合条件的记录
			query=session.createQuery(hql);
			this.setParam(query, paMap);
			query.setFirstResult(pageBean.getStartIndex());
			query.setMaxResults(pageBean.getRows());
			list=query.list();
		}else {
			query=session.createQuery(hql);
			this.setParam(query, paMap);
			list=query.list();
		}
		return list;
	}
}

其次还需要再BookDao中再写一个简化代码之后的方法

/**
	 * @param book
	 * @param pageBean
	 * @return
	 * 基于baseDao的plus
	 */
	public List<Book> listPlus(Book book,PageBean pageBean){
		Session session=SessionFactoryUtils.openSession();
//		Transaction transaction=session.beginTransaction();
		String hql="from Book where 1=1 ";
		String bname=book.getBookName();
		//这个map是jsp自动传递过来的，不需要手写
		Map<String, Object> map=new HashMap<String,Object>();
		if(StringUtils.isNotBlank(bname)) {
			hql+=" and bookName like :bookName";
			map.put("bookName", bname);
		}
		Query query=session.createQuery(hql );
		
		List list=super.executeQuery(hql, pageBean, map, session);
//		transaction.commit();
		session.close();
		return list;
	}

5. 最后在HQLTest中进行测试

	@Test
	public void testList11() {
		Book book=new Book();
		PageBean pageBean=new PageBean();
		pageBean.setPagination(false);
//		pageBean.setPage(2);
//		book.setBookName("%圣墟%");
		List<Book> list=this.bookDao.listPlus(book, pageBean);
		for (Book b : list) {
			System.out.println(b);
		}
	}

6. 测试结果
   模糊查询：book.setBookName("%圣墟%");
   
   前五条数据
   
   第二页的前五条数据：pageBean.setPage(2);
   
   不分页的查询所有数据：pageBean.setPagination(false);