这篇文章解决的核心问题是如何通过使用 MyBatis Generator 工具来简化数据库操作,减少手动编写基础 SQL 查询语句的工作量。通过自动生成的基础 Mapper 接口和实现类,开发人员可以快速实现常见的数据库操作,同时还可以自定义额外的业务查询方法,从而提高开发效率和代码质量。文章旨在帮助读者更快速地搭建数据库访问层,加速项目开发进程。
说直白点就是:我想在java里面根据实体,自动实现基础的查看,保存,更新的方法,以后不用写基础的mapper配置以及SQL。
在 Java 中根据实体类自动实现基础的查看、保存、更新方法,可以利用通用的持久层框架,比如 MyBatis 或者 Spring Data JPA,并结合反射技术来实现。这样可以避免重复编写大量的 CRUD(Create, Read, Update, Delete)相关的代码,同时也减少了对 XML 配置或者接口定义的依赖。
下面以 MyBatis 为例,展示如何使用 MyBatis 提供的通用 Mapper 插件来实现对实体的基础操作:
1、添加相关依赖
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper</artifactId>
<version>4.0.0</version>
</dependency>
2、创建一个 BaseMapper 接口,包含基础的查询方法:
import tk.mybatis.mapper.common.Mapper;
public interface BaseMapper<T> extends Mapper<T> {
}
3、创建一个 BaseDao 接口,定义通用的数据访问操作,例如 findAll、save、update 等方法:
import java.util.List;
public interface BaseDao<T> {
List<T> findAll();
T findById(Object id);
void save(T entity);
void update(T entity);
void delete(Object id);
}
4、实现BaseDao 接口,使用泛型和反射来自动实现基础的操作:
import org.springframework.beans.factory.annotation.Autowired;
import tk.mybatis.mapper.common.Mapper;
import java.lang.reflect.ParameterizedType;
import java.util.List;
public class BaseDaoImpl<T> implements BaseDao<T> {
@Autowired
private Mapper<T> mapper;
@Override
public List<T> findAll() {
return mapper.selectAll();
}
@Override
public T findById(Object id) {
return mapper.selectByPrimaryKey(id);
}
@Override
public void save(T entity) {
mapper.insert(entity);
}
@Override
public void update(T entity) {
mapper.updateByPrimaryKey(entity);
}
@Override
public void delete(Object id) {
mapper.deleteByPrimaryKey(id);
}
// 获取实体类信息
private Class<T> getEntityClass() {
return (Class<T>) ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0];
}
}
通过以上步骤,我们利用 MyBatis 的通用 Mapper 插件和反射机制,实现了自动化地基础操作方法,避免了繁琐的 CRUD 代码编写,同时使用泛型和反射使得代码更加通用和灵活。
以下是一个基于上述代码的简单示例。
1、创建User 实体类:
public class User {
private Long id;
private String name;
// 省略构造函数、getter和setter方法
}
2、定义UserMapper 接口,继承 BaseMapper,并添加自定义查询方法:
public interface UserMapper extends BaseMapper<User> {
List<User> findByName(String name);
// 可以在此添加其他自定义查询方法
}
3、创建UserDao 接口,继承 BaseDao,并定义额外的业务操作方法:
public interface UserDao extends BaseDao<User> {
User findByName(String name);
// 可以在此添加其他自定义操作方法
}
4、实现UserMapper 接口,并使用 MyBatis 注解进行 SQL 映射:
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface UserMapperImpl extends UserMapper {
}
5、实现UserDao 接口,继承 BaseDaoImpl,并注入 UserMapper:
import org.springframework.stereotype.Repository;
@Repository
public class UserDaoImpl extends BaseDaoImpl<User> implements UserDao {
private final UserMapper userMapper;
public UserDaoImpl(UserMapper userMapper) {
this.userMapper = userMapper;
}
@Override
public User findByName(String name) {
return userMapper.findByName(name);
}
}
现在,我们就可以在业务逻辑中使用 UserDao 来进行用户数据的操作了。
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class UserService {
private final UserDao userDao;
@Autowired
public UserService(UserDao userDao) {
this.userDao = userDao;
}
public void saveUser(User user) {
userDao.save(user);
}
public User getUserById(Long id) {
return userDao.findById(id);
}
public User getUserByName(String name) {
return userDao.findByName(name);
}
// 可以在此添加其他业务方法
}
使用示例:
public class Main {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
UserService userService = context.getBean(UserService.class);
// 保存用户
User user = new User();
user.setId(1L);
user.setName("Alice");
userService.saveUser(user);
// 根据ID查询用户
User retrievedUser = userService.getUserById(1L);
System.out.println(retrievedUser.getName());
// 根据名称查询用户
User userByName = userService.getUserByName("Alice");
System.out.println(userByName.getId());
}
}
在这个例子中,我们通过继承 BaseMapper 实现了自动生成的基础查找、保存、更新的方法。通过继承 BaseDao 和注入相应的 Mapper,我们可以实现对 User 实体的自定义查询操作。
通过使用 MyBatis Generator 自动生成的基础 Mapper 接口和实现类,可以避免手动编写重复的基础 SQL 查询语句,如插入、更新、删除和查询等。这些方法会根据实体类的属性自动生成对应的 SQL 语句,从而减少了开发人员编写和维护 SQL 的工作量。
在自定义的 Mapper 接口中,你可以添加一些额外的查询方法,以满足特定业务需求。这样就可以结合自动生成的基础 SQL 方法和自定义的查询方法,更快速、更方便地进行数据库操作,同时也提高了代码的可读性和可维护性。