Springカスタム名前空間
解説
Springはxmlファイル内のタグを解析するときに、現在のタグが4つの基本タグ（インポート、エイリアス、Bean、およびBean）であるかカスタムタグであるかを識別します。カスタムタグの場合、カスタムタグのロジックに従って現在のタグを解析しますラベルの。
バージョン2.0以降、Springフレームワークは、スキーマスタイルのSpring XML形式に基づいてBeanを定義するための拡張メカニズムを提供します。スキーマベースのXMLの導入は、従来のXML構成フォームを簡素化することです。
スキーマの定義を通じて、いくつかのBeanまたは複雑なBeanの組み合わせの定義によって元々定義する必要があるいくつかの構成フォームは、別のシンプルで読み取り可能な構成フォームで提示されます。
スキーマベースのXMLは3つの部分で構成されています。
- 名前空間-非常に明確な論理的分類があります
- 要素-非常に明確なプロセスセマンティクス
- 属性-非常に単純な構成オプションがあります
たとえば、次のとおりです。
<mvc:annotation-driven />
この構成の意味は、mvcの空間でアノテーション駆動型構成を実現することです。
その中で、
mvc構成の有効範囲を示しますannotation-drivenこれは動的なプロセスを表しています。実際の論理的な意味は次のとおりです。SpringMVC全体の実装は注釈モードに基づいています。関連する動作モードを登録してください。
カスタム
以下では、カスタムXML Bean定義の解析を記述し、この解析をSpring IOCコンテナーに統合する方法について説明します。
次のコンテンツでは、重要な概念がBeanの定義であることに言及します。実際、SpringにはBeanが重要な概念があります。BeanDefinitionオブジェクトは、オブジェクトを解析した後の対応するラベルです。
次の短い回答手順を使用して、新しいxml構成拡張を作成できます。
- カスタム要素を記述するXMLスキーマを作成する
- カスタムのNamespaceHandler実装のコーディング（これは非常に簡単な手順ですので、ご安心ください）
- 1つ以上のBeanDefinitionParse実装のコーディング（これが最も重要です）
- 登録者は上記をSpringに登録します（これも簡単な回答手順です）
例
SimpleDateFormatオブジェクト（java.textパッケージ内）を簡単な方法で設定できるようにするXML拡張（カスタムxml要素）を作成する必要があります。最後に、次のようにsimpleDateFormatタイプのBean定義を定義できます。
<myns:dateformat id="dateFormat"
pattern="yyyy-MM-dd HH:mm"
lenient="true"/>
1.構成を作成する
プロジェクトのリソースにファイルを作成します。
myns.xsd
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://www.mycompany.com/schema/myns"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:beans="http://www.springframework.org/schema/beans"
targetNamespace="http://www.mycompany.com/schema/myns"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xsd:import namespace="http://www.springframework.org/schema/beans"/>
<xsd:element name="dateformat">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="beans:identifiedType">
<xsd:attribute name="lenient" type="xsd:boolean"/>
<xsd:attribute name="pattern" type="xsd:string" use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
</xsd:schema>
上記のスキーマは、SimpleDateFormatオブジェクトの構成に使用されます。
XMLアプリケーションコンテキストファイルで直接使用されます<myns:dateformat />。
<myns:dateformat id="dateFormat"
pattern="yyyy-MM-dd HH:mm"
lenient="true"/>
注：上記のXMLフラグメントは、基本的に以下のXMLフラグメントと同じです。
<bean id="dateFormat" class="java.text.SimpleDateFormat">
<constructor-arg value="yyyy-HH-dd HH:mm"/>
<property name="lenient" value="true"/>
</bean>
2.名前空間プロセッサを作成する
上記のスキーマの場合、NamespaceHandlerSpringが遭遇するすべての特定のnamespace構成ファイルを解析する必要がありますelements。これによりNamespaceHandler、解析myns:dateformat要素が考慮されます。
NamespaceHandlerインターフェースは比較的シンプルで、3つの重要なメソッドが含まれています。
init()-NamespaceHandlerは、スプリングがハンドラーを使用する前にインスタンス化されますBeanDefinition parse(Element, ParseContext)-Springが上記で定義された最上位の要素（つまり、myms）を検出すると、それが呼び出されます。このメソッドは、Bean定義を登録し、Bean定義を返すことができます。BeanDefinitionHolder decorate(Node, BeanDefinitionHolder, ParserContext)-Springは、名前空間に埋め込まれた属性または要素を検出すると呼び出されます。
MyNamespaceHandler.java
package com.jeiker.namespace;
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
public class MyNamespaceHandler extends NamespaceHandlerSupport {
@Override
public void init() {
registerBeanDefinitionParser("dateformat", new SimpleDateFormatBeanDefinitionParser());
}
}
3.カスタムxml要素を解析する
BeanDefinitionParserの役割は、トップレベルでスキーマを定義するXML要素を解析することです。解析プロセス中に、XML要素にアクセスして、カスタムXMLコンテンツを解析できるようにする必要があります。
SimpleDateFormatBeanDefinitionParser.java
package com.jeiker.namespace;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;
import java.text.SimpleDateFormat;
public class SimpleDateFormatBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
@Override
protected Class getBeanClass(Element element) {
return SimpleDateFormat.class;
}
@Override
protected void doParse(Element element, BeanDefinitionBuilder bean) {
// this will never be null since the schema explicitly requires that a value be supplied
String pattern = element.getAttribute("pattern");
bean.addConstructorArgValue(pattern);
// this however is an optional property
String lenient = element.getAttribute("lenient");
if (StringUtils.hasText(lenient)) {
bean.addPropertyValue("lenient", Boolean.valueOf(lenient));
}
}
}
注：
- Springが提供するAbstractSingleBeanDefinitionParserを使用して、単一のBeanDefinitionを作成するいくつかの基本的な作業を処理します。
- 単一タイプのBeanDefinitionを作成するための独自のロジックを実装するために、AbstractSingleBeanDefinitionParser親クラスのdoParseメソッドを書き直しました。
4.スキーマとハンドラーをSpringに登録する
4.1登録スキーマ
リソースで作成
META-INF / spring.schemas
http\://www.mycompany.com/schema/myns/myns.xsd=xml/myns.xsd
4.2ハンドラーの登録
リソースで作成
META-INF / spring.handlers
http\://www.mycompany.com/schema/myns=com.jeiker.namespace.MyNamespaceHandler
5.テスト
5.1 schema-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:myns="http://www.mycompany.com/schema/myns"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.mycompany.com/schema/myns http://www.mycompany.com/schema/myns/myns.xsd">
<myns:dateformat id="dateFormat"
pattern="yyyy-MM-dd HH:mm"
lenient="true"/>
</beans>
5.2テストカテゴリ
package com.jeiker.namespace;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import java.text.SimpleDateFormat;
import java.util.Date;
public class SchemaBeanDefinitionTest {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("schema-beans.xml");
SimpleDateFormat dateFormat = context.getBean("dateFormat", SimpleDateFormat.class);
System.out.println("-------------------gain object--------------------");
System.out.println(dateFormat);
String dateStr = dateFormat.format(new Date());
System.out.println(dateStr);
}
}
