自制Java轻量级框架

Milky是一个自制的简易Java框架,并开放了一些扩展接口,可以以此开发插件。
Github地址: https://github.com/ZhengChenYang/milky

快速开始

本框架配置方便,使用简单。在使用框架前需要先引入依赖包milky.jar。首先,我们从一个简单的项目开始,逐步演示如何使用本框架。

创建xml文件

xml文件中的根节点必须是<beans>,否则在读取配置的时候会抛出错误。<beans>的子节点指定具体的<bean>节点。<bean>节点中,需要指定id属性(这是必须的),以及class属性,scope属性,这些都是必须的。
创建一个xml文件

<?xml version="1.0" encoding="UTF-8" ?>
<beans>
    <bean id="testBean" class="Test" scope="singleton"></bean>
</beans>

上面这段xml配置,指定了id,class,scope属性。id属性的值必须是容器中唯一的。class属性指定了bean的类类型。scope属性指定了bean的周期,它在容器中是单例的。这样配置的bean会直接调用默认构造函数来实例化bean。

配置构造函数

选择使用的构造函数,我们需要对构造函数的参数进行配置。在<bean>的子节点进行配置。<constructor-arg>节点代表一个参数。

<?xml version="1.0" encoding="UTF-8" ?>
<beans>
    <bean id="testBean" class="Test" scope="singleton">
        <constructor-arg index="1" type="char" name="a" value="abc" />
        <constructor-arg index="2" type="int" name="b" value="2" />
        <constructor-arg index="3" type="int" name="c" value="3" />
    </bean>
</beans>

在上面配置中,index属性指定参数在参数列表中的序列(从0开始),type属性指定参数的类型,name属性指定参数名,value属性指定属性值。接下来我们读取配置,并且输出这个bean的属性看看。

File file = new File("C:\\Users\\52678\\Desktop\\file\\project\\milky\\src\\main\\resources\\test.xml");
FileSystemResource fsr = new FileSystemResource(file);
XmlBeanFactory factory = new XmlBeanFactory();
factory.loadResource(fsr);
Test testA = (Test) factory.getBean("testBean");
System.out.println(testA.toString());

这是以上代码运行的输出

Test{a=a, b=2, c=3, s=false, str=null}

可以看到上面的代码容器包装类XmlBeanFactory加载了这个配置,并通过getBean()方法来获得指定的bean的实例。输出的结果可以看到,a,b,c三个属性都通过构造器得到了注入。

属性setter注入

依赖注入除了通过构造器的方式注入,也可以通过属性的setter方法注入。同样我们需要对xml进行配置。

<?xml version="1.0" encoding="UTF-8" ?>
<beans>
    <bean id="testBean" class="Test" scope="singleton">
        <constructor-arg index="1" type="char" name="a" value="abc" />
        <constructor-arg index="2" type="int" name="b" value="2" />
        <constructor-arg index="3" type="int" name="c" value="3" />
        <property name="s" value="true" />
    </bean>
</beans>

<property>标签用来指定需要注入的属性,标签中的name属性指定了注入属性名,value指定了注入的值,ref指定了注入的引用对象。需要注意的时,value属性和ref属性不能同时使用,即一次只能选择一个属性进行注入。修改了xml后,我们重新运行之前的代码,来看看id为testBean的bean发生了怎么样的变化。

这是以上代码运行的输出

Test{a=a, b=2, c=3, s=true, str=null}

我们可以看到,属性名为s的属性值不再是初始的false,而是通过依赖注入修改为了true。

配置AOP

用xml配置切面

<!-- 切面bean -->
<bean id="transactionPointCut" class="PointCut" />

<!-- aop配置 -->
<aop-config>
    <!-- 定义相关的切面 -->
    <aop-aspect ref="transactionPointCut">
        <!-- 定义切入点 -->
        <aop-pointcut expression=" aopTest[0-9]" id="transactionPointCut"/>
        <aop-before pointcut-ref="transactionPointCut" method="beginTransaction"/>
        <aop-after pointcut-ref="transactionPointCut" method="commitTransaction"/>
        <aop-after-throwing pointcut-ref="transactionPointCut" method="rollBackTransaction"/>
    </aop-aspect>
</aop-config>

Test类部分代码

// Test.java
public void aopTest0(){
    System.out.println("this is aop test");
}

public void aopTest1(){
    System.out.println("this is aop test2");
}

PoinCut类代码

//PoinCut.java
public class PointCut {
    public void beginTransaction(){
        System.out.println("--- begin transaction ---");
    }

    public void commitTransaction(){
        System.out.println("--- commit transaction ---");
    }

    public void rollBackTransaction(){
        System.out.println("--- rollback transaction ---");
    }
}

切入点的定义使用<aop-pointcut>节点来定义,其中的属性expression必须是正则表达式。只有类中的方法可以被增强,并且可以进行前置增强和后置增强,以及方法抛出错误后的处理。正则表达式需要指定类名+空格+方法名的方式来匹配。
接着我们运行代码,看下方法的增强效果。

Test testA = (Test) factory.getBean("testBean");
testA.aopTest0();
testA.aopTest1();

下面是输出

--- begin transaction ---  
this is aop test  
--- commit transaction ---
  
--- begin transaction ---  
this is aop test2  
--- commit transaction ---  

扩展接口

注册bean

MicroKernel中有注册bean配置的接口registerBeanDefinition(String beanName, Beandefinition beanDefinition)。实际上,xml解析时正是对标签进行解析,然后将元数据填充到BeanDefinition中。当然,我们可以从任何数据格式上进行解析,然后根据自定义的逻辑填充到BeanDefinition。bean的注册接口就显得额外重要。我们来看下BeanDefinition的实例代码。

BeanDefinition beanDefinition = new BeanDefinition();
// bean name
beanDefinition.setName("firstBean");
beanDefinition.setScope("singleton");
beanDefinition.setBeanClass(Test.class);

// bean constructor
int offset = 1;
int count = 3;
ConstructorArgumentValues cav = new ConstructorArgumentValues();
cav.addArgumentValue(0,
        new ConstructorArgumentValues.ValueHolder(
                "a",
                char.class.getName(),
                null)
);
beanDefinition.setConstructorArgumentValues(cav);

// set attribute
PropertyValue propertyValue = new PropertyValue();
propertyValue.setName("s");
propertyValue.setValue("True");
beanDefinition.addProperty(propertyValue);

// register the bean definition to the MicroKernel
MicroKernel microKernel = new MicroKernel();
try {
    microKernel.registerBeanDefinition("firstBean", beanDefinition);
} catch (Exception e) {
    e.printStackTrace();
    System.out.println("cannot register the bean definition");
}

xml自定义标签

xml解析器开放了对自定义标签解析的接口。自定义标签的解析器需要实现XMlTagParse接口,然后将实例化的对象注册到xml解析器中。

// AopXmlTagParser.java
public class AopXmlTagParser implements XmlTagParser {
    public void parse(Element ele, BeanDefinition bd) {
            try {
                parseAopAspectElements(ele, bd);
                bd.setBeanClass(AopPostFactoryProcessor.class);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }

    //...
}

// 注册自定义标签解析器
factory.registerCustomTagParser("aop-config", new AopXmlTagParser());

自定义标签解析器注册时,需要传入标签的名字,这是唯一指定的。

MicroKernelPostProcess接口

MicroKernelPostProcess主要用于短路注册bean的逻辑。如果beanDefinition中的beanClass属性是MicroKernelPostProcessor的子类,容器不会将该beanDefinition进行注册,而是通过反射,实例化该类。然后调用接口中的postProcess()方法执行特殊的逻辑。AOP正式通过这种方式,在容器中注册了BeanDefinitionPostProcess。

public class AopPostFactoryProcessor implements MicroKernelPostProcessor{

    private static final String AOP_KEY = "aop";
    @Override
    public void postProcess(BeanDefinition bd, MicroKernel microKernel) {
        AopBeanDefinitionPostProcessor beanDefinitionPostProcessor = new AopBeanDefinitionPostProcessor();
        Map<String, Object> customizedFeatureMap = bd.getCustomizedFeatureMap();
        Object value = customizedFeatureMap.get(AOP_KEY);
        beanDefinitionPostProcessor.setAopAspect((AopAspect)value);
        microKernel.registerBeanDefinitionPostProcessor(beanDefinitionPostProcessor);
    }
}

BeanDefinitionPostProcess接口

BeanDefinitionPostProcess主要用于实例化过程中的判断。在返回值非null的情况下,它会跳过容器内部的实例化,从而使用BeandefinitionPostProcess返回的实例对象。它可以用于短路实例化过程,从而使用自定义的方式进行实例化。在AOP模块中,正是向
容器中注册了一个BeanDefinitionPostProcess,从而使其短路了默认的bean实例化过程,而使用CGLib进行实例化。以下是BeanDefinitionPostProcess的一个实现类

public class AopBeanDefinitionPostProcessor implements BeanDefinitionPostProcessor {
    private AopAspect aopAspect;

    @Override
    public Object postProcess(Constructor constructor, Object[] params, BeanDefinition bd, MicroKernel microKernel) throws Exception {
        // ...
            
        // 注意,不是返回null,从而短路了默认的实例化过程
        return bean;
    }
}

类型转换

DataPropertyEditorRegistrar是一个管理类型转换的类。默认情况下,DataPropertyEditorRegistrar提供了15种类型的转换。他们将字符串按照一定的逻辑转换为对应类对象。正是这个DataPropertyEditorRegistrar类的存在,BeanDefinition中的元数据可以通过DataPropertyEditorRegistrar转换为对应的对象,从而实现了属性的注入。DataPropertyEditorRegistrar开放了注册口,用户可以自定义转换类型。所有的类型转换类必须实现DataEditorSupport接口。接下来,我们实现一个简单的String转换为Date的例子。

public class DatePropertyEditor extends DataEditorSupport{
    private String format = "yyyy-MM-dd";
    public Object edit(String rawValue){
        SimpleDateFormat sdf = new SimpleDateFormat(format);
        Date d = null;
        try{
             d = sdf.parse(raw);                    
        }catch(ParseException e){
            e.printStackTrace();
        }
        return d;
    }
}

上面演示了如何创建一个类型转换的类。接着,我们把这个类进行注册。

DataPropertyEditorRegistrar.register(Date.class, new DatePropertyEditor());

注册完后,容器就具备了将String转换为Date类型的能力了。

TypeConverter接口

TypeConverter接口是一个有趣的接口。当beanDefinition中的初始值不是String时,它不会调用DataPropertyEditorRegistrar进行转换,而是采用了TypeConverter接口中的方法convert()。也就是说,用户可以自定义复杂的转换方式。单纯的String有时候难以表示复杂的类,因此,用于自定义如何转换复杂的类就显得尤为必要实现TypeConverter接口的类会调用convert()方法或者最终转换后的对象。容器中提供的array,list,map,set等集合类由于表示复杂,不易用String表示,因此会被解析成TypeConverter接口的实现类来保存元数据,最终通过该实现类返回转换后的对象。

public class ManagedList extends ArrayList<ManagedList.Entry> implements TypeConverter {
    private String elementTypeName;

    public Object convert(MicroKernel microKernel) throws Exception {
        List<Object> list = new ArrayList<Object>();
        //...
        return list;
    }

    //...
}

以上就是一个实现TypeConverter接口的类,xml解析器在读取XML配置并完成解析后,会将元数据存储在该类中,最后在容器中,通过调用convert方法正式转换成List类的对象。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,458评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,454评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,171评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,062评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,440评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,661评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,906评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,609评论 0 200
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,379评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,600评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,085评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,409评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,072评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,088评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,860评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,704评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,608评论 2 270

推荐阅读更多精彩内容