SpringDataJPA方法命名规范

SpringDataJPA配置及其方法命名规范

示例：

1.Employee实体类：

@Entity
public class Employee {
	private Integer empId;
	private String empAddress;
	private Integer empAge;
	private String empGender;
	private String empName;
	private Double empSalary;
	private Date empStartDate;
	private Integer empStatus;
//	private String deptId; 
	private Department dept;
	
	
	@Id
	@GeneratedValue(strategy=GenerationType.IDENTITY)
	public Integer getEmpId() {
		return empId;
	}
	public void setEmpId(Integer empId) {
		this.empId = empId;
	}
	public String getEmpAddress() {
		return empAddress;
	}
	public void setEmpAddress(String empAddress) {
		this.empAddress = empAddress;
	}
	public Integer getEmpAge() {
		return empAge;
	}
	public void setEmpAge(Integer empAge) {
		this.empAge = empAge;
	}
	public String getEmpGender() {
		return empGender;
	}
	public void setEmpGender(String empGender) {
		this.empGender = empGender;
	}
	public String getEmpName() {
		return empName;
	}
	public void setEmpName(String empName) {
		this.empName = empName;
	}
	public Double getEmpSalary() {
		return empSalary;
	}
	public void setEmpSalary(Double empSalary) {
		this.empSalary = empSalary;
	}
	public Date getEmpStartDate() {
		return empStartDate;
	}
	public void setEmpStartDate(Date empStartDate) {
		this.empStartDate = empStartDate;
	}
	public Integer getEmpStatus() {
		return empStatus;
	}
	public void setEmpStatus(Integer empStatus) {
		this.empStatus = empStatus;
	}
	@ManyToOne
	@JoinColumn(name="deptId")
	public Department getDept() {
		return dept;
	}
	public void setDept(Department dept) {
		this.dept = dept;
	}
	@Override
	public String toString() {
		return "Employee [empId=" + empId + ", empAddress=" + empAddress + ", empAge=" + empAge + ", empGender="
				+ empGender + ", empName=" + empName + ", empSalary=" + empSalary + ", empStartDate=" + empStartDate
				+ ", empStatus=" + empStatus + "]";
	}
	public Employee(Integer empId, String empAddress, Integer empAge, String empGender, String empName,
			Double empSalary, Date empStartDate, Integer empStatus) {
		super();
		this.empId = empId;
		this.empAddress = empAddress;
		this.empAge = empAge;
		this.empGender = empGender;
		this.empName = empName;
		this.empSalary = empSalary;
		this.empStartDate = empStartDate;
		this.empStatus = empStatus;
	}
	public Employee() {
	}
	public Employee(Integer empId, String empName, Double empSalary) {
		
		super();
//		System.out.println("调用了三个参数的有参构造方法");
		this.empId = empId;
		this.empName = empName;
		this.empSalary = empSalary;
	}
}

2.EmployeeDao接口层：

/**
 * Repository<T, Serializable>:
 * 			T：表示，当前接口，操作的实体类类型
 * Serializable:指定主键的类型
 * @author boge
 *
 */
public interface EmployeeDao  extends CrudRepository<Employee, Integer>{
	//只需要按照springdata提供的命名规范，根据查询需求，来为方法命名即可。
	//如：当前我们希望按照性别查询员工信息，拼接方法名，符合驼峰命名法
	//指定符合逻辑的方法返回值与参数列表
		public List<Employee> findByEmpGender(String gender);
		
		
		//按照姓名进行查询
		public List<Employee> findByEmpName(String empName);
		//按照姓氏进行模糊查询
		public List<Employee> findByEmpNameLike(String empName);
		//按照年龄查询
		public List<Employee> findByEmpAge(Integer age);
		//按照empAddress查询
		public List<Employee> findByEmpAddress(String address);
		//查找年龄大于50的员工信息
		public List<Employee> findByEmpAgeGreaterThan(Integer age);
		
		//查询50岁以上的男性员工
		public List<Employee> findByEmpAgeGreaterThanAndEmpGender(Integer age,String gender);
		
		/**
		 * 查询所有男性员工信息
		 */
		public List<Employee> findByEmpGender(String gender);
		
		/**
		 * 按照性别查询，并且按照年龄进行降序排序
		 */
		public List<Employee> findByEmpGenderOrderByEmpAgeDesc(String gender);
		
		/**
		 * 按照部门编号，查找员工信息
		 * 	可以使用级联查询，非常方便，自动将对应的字段转换成关联的另一个实体类
		 * 也有一种情况：
		 * 	级联查询的最终拼接成的DeptDeptId，恰好与当前实体类的某一个属性同名deptDeptId
		 * 优先，使用当前实体类的这个属性。
		 * 如果遇到这种情况，还想继续使用级联查询：
		 * 	可以通过下划线，来区分：
		 * 	
		 */
		public List<Employee> findByDept_DeptId(Integer deptId);
		
		/**
		 * 还可以在方法参数中，使用分页参数（Pageable）、排序参数（Sort），实现分页与排序功能。
		 * 按照年龄区间范围查询，并且分页显示
		 */
		public List<Employee> findByEmpAgeBetween(Integer start,Integer end);
		//添加分页功能，通过方法重载，添加分页参数（Pageable）
		public List<Employee> findByEmpAgeBetween(Integer start,Integer end,Pageable pageable);
}

3.测试类：

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations="classpath:spring-beans.xml")
public class EmployeeDaoTest  {
@Autowired
EmployeeDao dao;
	@Test
	public void testFindByEmpGender() {
		List<Employee> findByEmpGender = dao.findByEmpGender("男");
		for (Employee employee : findByEmpGender) {
			System.out.println(employee);
		}
	}

	@Test
	public void testFindByEmpName() {
		List<Employee> employee = dao.findByEmpName("周聪");
		for (Employee employee2 : employee) {
			System.out.println(employee2);
		}	
	}

	@Test
	public void testFindByEmpNameLike() {
		List<Employee> findByEmpNameLike = dao.findByEmpNameLike("张%");
		for (Employee employee : findByEmpNameLike) {
			System.out.println(employee);	
		}
	}
	
	@Test
	public void testFindByEmpAgeGreaterThanAndEmpGender() {
		List<Employee> list = dao.findByEmpAgeGreaterThanAndEmpGender(50, "男");
		for (Employee employee : list) {
			System.out.println(employee);	
		}
	}

	@Test
	public void testFindByEmpAge() {
		List<Employee> employee = dao.findByEmpAge(50);
		for (Employee employee2 : employee) {
			System.out.println(employee2);
		}	
	}

	@Test
	public void testFindByEmpAddress() {
		List<Employee> employee = dao.findByEmpAddress("北京");
		for (Employee employee2 : employee) {
			System.out.println(employee2);
		}	
	}

	@Test
	public void testFindByEmpAgeGreaterThan() {
		List<Employee> employee = dao.findByEmpAgeGreaterThan(50);
		for (Employee employee2 : employee) {
			System.out.println(employee2);
		}	
	}

	@Test
	public void testFindByEmpAgeBetween(){
		//指定分页参数 参数1：页码，页码从0开始，参数2：每页显示大小
		PageRequest pageRequest = new PageRequest(0, 5);
		List<Employee> result = employeeDao.findByEmpAgeBetween(20,50,pageRequest);
		for (Employee employee : result) {
			System.out.println(employee.getEmpName()+":"+employee.getEmpAge()+":"+employee.getEmpGender());
		}
	}
	@Test
	public void testFindByDeptDeptId(){
		List<Employee> result = employeeDao.findByDept_DeptId(4);
		for (Employee employee : result) {
			System.out.println(employee.getEmpName()+":"+employee.getEmpAge()+":"+employee.getEmpGender());
		}
	}
	@Test
	public void testFindByEmpGenderOrderByEmpAgeDesc(){
		List<Employee> findByEmpGenderOrderByEmpAgeDesc = employeeDao.findByEmpGenderOrderByEmpAgeDesc("女");
		for (Employee employee : findByEmpGenderOrderByEmpAgeDesc) {
			System.out.println(employee.getEmpName()+":"+employee.getEmpAge()+":"+employee.getEmpGender());
		}
	}
	

	@Test
	public void testFindByEmpGender() {
		List<Employee> findByEmpGender = employeeDao.findByEmpGender("男");
		for (Employee employee : findByEmpGender) {
			System.out.println(employee.getEmpName()+":"+employee.getEmpAge()+":"+employee.getEmpGender());
		}
	}
}

4.spring-beans.xml配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xmlns:jpa="http://www.springframework.org/schema/data/jpa"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd		http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa-1.3.xsd		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">

	<context:property-placeholder location="classpath:jdbc.properties" />
	<!-- 配置数据源 -->
	<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
		<!-- 配置连接属性 -->
		<property name="user" value="${jdbc.user}"></property>
		<property name="password" value="${jdbc.password}"></property>
		<property name="driverClass" value="${jdbc.driverClass}"></property>
		<property name="jdbcUrl" value="${jdbc.jdbcUrl}"></property>
	</bean>

	<!-- 扫描service -->
	<context:component-scan base-package="com.kmu.service"></context:component-scan>

	<!-- Spring整合JPA的相关配置 Spring为整合JPA，提供了响应的整合的类，EntityManagerFactory 将关于spring整合jpa的相关配置，都放到了entityManagerFactorybean中 
		那么，这个bean就是以后，我们实现Spring整合JPA的关键类 -->
	<bean id="entityManagerFactory"
		class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
		<!-- 数据源 -->
		<property name="dataSource" ref="dataSource"></property>
		<!-- 配置JPA实现的适配器 -->
		<property name="jpaVendorAdapter">
			<bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter"></bean>
		</property>
		<!-- 配置与数据映射的实体类所在的包，对应之前的class标签 -->
		<property name="packagesToScan" value="com.kmu.entity"></property>
		<property name="jpaProperties">
			<props>
				<!-- 数据表的列的映射策略 可选的 <prop key="hibernate.ejb.naming_strategy">org.hibernate.cfg.ImprovedNamingStrategy</prop> -->

				<!-- 底层实现框架，hibernate 基本属性 -->
				<prop key="hibernate.dialect">org.hibernate.dialect.MySQL5InnoDBDialect</prop>
				<prop key="hibernate.show_sql">true</prop>
				<prop key="hibernate.format_sql">true</prop>
				<prop key="hibernate.hbm2ddl.auto">update</prop>
			</props>
		</property>
	</bean>


	<!-- 事务 -->
	<bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
		<property name="entityManagerFactory" ref="entityManagerFactory"></property>
	</bean>
	<!-- 开启事务的注解驱动 -->
	<tx:annotation-driven transaction-manager="transactionManager" />
	<!-- 配置，持久层的组件 base-package：指定持久层所在的包 -->
	<jpa:repositories base-package="com.kmu.repository"
		entity-manager-factory-ref="entityManagerFactory"></jpa:repositories>

</beans>

5.jdbc.properties配置文件

jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.jdbcUrl=jdbc:mysql://localhost:3306/jpa
jdbc.user=root
jdbc.password=123123

6.所用到的jar包：

百度网盘：
链接：https://pan.baidu.com/s/1Wu6CXl2gOR7_ngM-wf4Ltw
提取码：txpp