如何面对复杂系统的设计?
我们可以把 Spring、MyBatis、Dubbo 这样的大型框架或者一些公司内部的较核心的项目,都可以称为复杂的系统。
这样的工程也不在是初学编程手里的玩具项目,没有所谓的 CRUD,更多时候要面对的都是对系统分层的结构设计和聚合逻辑功能的实现,再通过层层转换进行实现和调用。
这对于很多刚上道的小码农来说,会感觉非常难受,不知道要从哪下手,但又想着可以一口吃个胖子。
其实这是不现实的,因为这些复杂系统中的框架中有太多的内容你还没用和了解和熟悉,越是硬搞越难受,信心越受打击。
其实对于解决这类复杂的项目问题,核心在于要将分支问题点缩小,突出主干链路,具体的手段包括:分治、抽象和知识。
运用设计模式和设计原则等相关知识,把问题空间合理切割为若干子问题,问题越小也就越容易理解和处理。
就像你可以把很多内容做成单个独立的案例一样,最终在进行聚合使用。
在上一章节我们初步的了解了怎么给一个接口类生成对应的映射器代理,并在代理中完成一些用户对接口方法的调用处理。
虽然我们已经看到了一个核心逻辑的处理方式,但在使用上还是有些刀耕火种的,包括:需要编码告知 MapperProxyFactory 要对哪个接口进行代理,以及自己编写一个假的 SqlSession 处理实际调用接口时的返回结果。
那么结合这两块问题点,我们本章节要对映射器的注册提供注册机处理,满足用户可以在使用的时候提供一个包的路径即可完成扫描和注册。
与此同时需要对 SqlSession 进行规范化处理,让它可以把我们的映射器代理和方法调用进行包装,建立一个生命周期模型结构,便于后续的内容的添加。
鉴于我们希望把整个工程包下关于数据库操作的 DAO 接口与 Mapper 映射器关联起来,那么就需要包装一个可以扫描包路径的完成映射的注册器类。
当然我们还要把上一章节中简化的 SqlSession 进行完善,由 SqlSession 定义数据库处理接口和获取 Mapper 对象的操作,并把它交给映射器代理类进行使用。这一部分是对上一章节内容的完善。
有了 SqlSession 以后,你可以把它理解成一种功能服务,有了功能服务以后还需要给这个功能服务提供一个工厂,来对外统一提供这类服务。比如我们在 MyBatis 中非常常见的操作,开启一个 SqlSession。整个设计图如下:
step-02
├───src
│ ├───main
│ │ ├───java
│ │ │ └───top
│ │ │ └───it6666
│ │ │ └───mybatis
│ │ │ ├───binding
│ │ │ └───session
│ │ │ └───defaults
│ │ └───resources
│ └───test
│ └───java
│ └───top
│ └───it6666
│ └───test
│ └───dao
工程源码:https://github.com/BNTang/Java-All/tree/main/mybatis-source-code/step-02
映射器标准定义实现关系,如下图:
在 top.it6666.mybatis.session:编写 SqlSession 接口,代码如下:
/**
* @author BNTang
* @version 1.0
* @description SqlSession 标准定义和实现
* @since 2024/6/16 星期日
**/
public interface SqlSession {
/**
* Retrieve a single row mapped from the statement key
* 根据指定的SqlID获取一条记录的封装对象
*
* @param <T> the returned object type 封装之后的对象类型
* @param statement sqlID
* @return Mapped object 封装之后的对象
*/
<T> T selectOne(String statement);
/**
* Retrieve a single row mapped from the statement key and parameter.
* 根据指定的SqlID获取一条记录的封装对象,只不过这个方法容许我们可以给sql传递一些参数
* 一般在实际使用中,这个参数传递的是pojo,或者Map或者ImmutableMap
*
* @param <T> the returned object type
* @param statement Unique identifier matching the statement to use.
* @param parameter A parameter object to pass to the statement.
* @return Mapped object
*/
<T> T selectOne(String statement, Object parameter);
/**
* Retrieves a mapper.
* 得到映射器,这个巧妙的使用了泛型,使得类型安全
*
* @param <T> the mapper type
* @param type Mapper interface class
* @return a mapper bound to this SqlSession
*/
<T> T getMapper(Class<T> type);
}
在 top.it6666.mybatis.session.defaults:编写 DefaultSqlSession 实现类,代码如下:
/**
* @author BNTang
* @version 1.0
* @description SqlSession 的默认实现
* @since 2024/6/16 星期日
**/
public class DefaultSqlSession implements SqlSession {
/**
* 映射器注册机
*/
private MapperRegistry mapperRegistry;
public DefaultSqlSession(MapperRegistry mapperRegistry) {
this.mapperRegistry = mapperRegistry;
}
/**
* Retrieve a single row mapped from the statement key
* 根据指定的SqlID获取一条记录的封装对象
*
* @param statement sqlID
* @return Mapped object 封装之后的对象
*/
@Override
public <T> T selectOne(String statement) {
return (T) ("你的操作被代理了!" + statement);
}
/**
* Retrieve a single row mapped from the statement key and parameter.
* 根据指定的SqlID获取一条记录的封装对象,只不过这个方法容许我们可以给sql传递一些参数
* 一般在实际使用中,这个参数传递的是pojo,或者Map或者ImmutableMap
*
* @param statement Unique identifier matching the statement to use.
* @param parameter A parameter object to pass to the statement.
* @return Mapped object
*/
@Override
public <T> T selectOne(String statement, Object parameter) {
return (T) ("你的操作被代理了!" + "方法:" + statement + " 入参:" + parameter);
}
/**
* Retrieves a mapper.
* 得到映射器,这个巧妙的使用了泛型,使得类型安全
*
* @param type Mapper interface class
* @return a mapper bound to this SqlSession
*/
@Override
public <T> T getMapper(Class<T> type) {
return mapperRegistry.getMapper(type, this);
}
}
在 top.it6666.mybatis.session:编写 SqlSessionFactory 接口,代码如下:
/**
* @author BNTang
* @version 1.0
* @description SqlSessionFactory 工厂定义和实现
* @since 2024/6/16 星期日
**/
public interface SqlSessionFactory {
/**
* 打开一个 session
*
* @return SqlSession
*/
SqlSession openSession();
}
在 top.it6666.mybatis.session.defaults:编写 DefaultSqlSessionFactory 实现类,代码如下:
/**
* @author BNTang
* @version 1.0
* @description SqlSessionFactory 工厂定义和实现
* @since 2024/6/16 星期日
**/
public class DefaultSqlSessionFactory implements SqlSessionFactory {
private final MapperRegistry mapperRegistry;
public DefaultSqlSessionFactory(MapperRegistry mapperRegistry) {
this.mapperRegistry = mapperRegistry;
}
/**
* 打开一个 session
*
* @return SqlSession
*/
@Override
public SqlSession openSession() {
return new DefaultSqlSession(mapperRegistry);
}
}
在这段代码的实现中,需要用到包扫描的功能,所以我引入了 Hutool 工具包,用于扫描包路径下的所有类,先添加 pom 依赖:
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.5.0</version>
</dependency>
在进行实现之前需要将之前的 MapperProxyFactory newInstance 方法接收参数进行改改之前是 Map<String, String> sqlSession
现在改为 SqlSession sqlSession
,这样就 MapperProxy 中的 SqlSession 也需要进行更改在 MapperProxy 中就可以通过本次传递的 SqlSession 对象进行操作了。
然后在 top.it6666.mybatis.binding:MapperRegistry 类中实现包扫描功能,代码如下:
/**
* @author BNTang
* @version 1.0
* @description 映射器注册机
* @since 2024/6/16 星期日
**/
public class MapperRegistry {
/**
* 将已添加的映射器代理加入到 HashMap
*/
private final Map<Class<?>, MapperProxyFactory<?>> knownMappers = new HashMap<>();
public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
if (mapperProxyFactory == null) {
throw new RuntimeException("Type " + type + " is not known to the MapperRegistry.");
}
try {
return mapperProxyFactory.newInstance(sqlSession);
} catch (Exception e) {
throw new RuntimeException("Error getting mapper instance. Cause: " + e, e);
}
}
public <T> void addMapper(Class<T> type) {
// Mapper 必须是接口才会注册
if (type.isInterface()) {
if (hasMapper(type)) {
// 如果重复添加了,报错
throw new RuntimeException("Type " + type + " is already known to the MapperRegistry.");
}
// 注册映射器代理工厂
knownMappers.put(type, new MapperProxyFactory<>(type));
}
}
public <T> boolean hasMapper(Class<T> type) {
return knownMappers.containsKey(type);
}
public void addMappers(String packageName) {
Set<Class<?>> mapperSet = ClassScanner.scanPackage(packageName);
for (Class<?> mapperClass : mapperSet) {
addMapper(mapperClass);
}
}
}
在同一个包路径下,提供2个以上的 Dao 接口:
/**
* @author BNTang
* @version 1.0
* @description 学校接口
* @since 2024/6/16 星期日
**/
public interface ISchoolDao {
String querySchoolName(String uId);
String querySchoolName();
}
/**
* 用户接口
*/
public interface IUserDao {
String queryUserName(String uId);
Integer queryUserAge(String uId);
}
/**
* @author BNTang
* @version 1.0
* @description 测试类
* @since 2024/4/16 星期二
**/
public class ApiTest {
private final Logger logger = LoggerFactory.getLogger(ApiTest.class);
@Test
public void test_MapperProxyFactory() {
// 1. 注册 Mapper
MapperRegistry registry = new MapperRegistry();
registry.addMappers("top.it6666.test.dao");
// 2. 从 SqlSession 工厂获取 Session
SqlSessionFactory sqlSessionFactory = new DefaultSqlSessionFactory(registry);
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3. 获取映射器对象
ISchoolDao iSchoolDao = sqlSession.getMapper(ISchoolDao.class);
// 4. 测试验证
String res = iSchoolDao.querySchoolName("neo");
logger.info("测试结果:{}", res);
}
}
19:48:09.984 [main] INFO top.it6666.test.ApiTest - 测试结果:你的操作被代理了!方法:querySchoolName 入参:[Ljava.lang.Object;@5fe5c6f
着急和快,是最大的障碍!慢下来,慢下来,只有慢下来,你才能看到更全的信息,才能学到更扎实的技术。而那些满足你快的短篇内容虽然有时候更抓眼球,但也容易把人在技术学习上带偏,总想着越快越好。
如果您觉得文章对您有所帮助,欢迎您点赞、评论、转发,也欢迎您关注我的公众号『BNTang』,我会在公众号中分享更多的技术文章。
相信大家对Spring都有一定的了解,本篇文章我们会针对Spring底层原理,在海量的Spring源代码中进行抽丝剥茧手动实现一个Spring简易版本,对Spring的常用功能进行手写模拟实现。