java

位置:IT落伍者 >> java >> 浏览文章

Spring-OSGI 1.0 M3 中文手册


发布日期:2020年11月29日
 
Spring-OSGI 1.0 M3 中文手册

关于headers的细节参见OSGi规范中的一些OSGi实现框架可能会支持一些与众不同的jar包但是这些jar包关于OSGi的格式还是不变的

The Spring extender recognizes a bundle as Springpowered and will create an associated application context when the bundle is started if one or both of the following conditions is true:

如果满足以下两个条件Spring extender会通过一个bundle的具有Springpowered的验证当这个bundle启动时会为其创建一个相关联的application context

The bundle classpath contains a folder METAINF/spring with one or more files in that folder with a xml extension

这个bundle的classpath包含一个目录METAINF/spring这个目录中有一个或多个扩展名为xml的文件

METAINF/MANIFESTMF contains a manifest header SpringContext

这个bundle中的METAINF/MANIFESTMF文件包含一个名为SpringContext的header

In addition if the optional SpringExtenderVersion header is declared in the bundle manifest then the extender will only recognize bundles where the specified version constraints are satisfied by the version of the extender bundle (BundleVersion) The value of the SpringExtenderVersion header must follow the syntax for a version range as specified in section of the OSGi Service Platform Core Specification

另外如果bundle的manifest声明了可选header SpringExtenderVersion那么extender将仅仅认可与之版本相符的指定版本约束的bundle(bundle的BundleVersion)SpringExtenderVersion的值必须遵循OSGi规范节中指定的版本范围

In the absence of the SpringContext header the extender expects every xml file in the METAINF/spring folder to be a valid Spring configuration file and all directives (see below) take on their default values

在缺少SpringContext的情况下spring extender仍然认为所有METAINF/spring中xml的文件都是spring的配置文件所有的header都是默认值

An application context is constructed from this set of files A suggested practice is to split the application context configuration into at least two files named by convention modulenamecontextxml and modulenameosgicontextxml The modulenamecontextxml file contains regular bean definitions independent of any knowledge of OSGi The modulenameosgicontextxml file contains the bean definitions for importing and exporting OSGi services It may (but is not required to) use the Spring Dynamic Modules OSGi schema as the toplevel namespace instead of the Spring beans namespace

application context就是根据这些文件(METAINF/spring中xml的文件)构造的一个推荐的做法是将application context配置文件至少分割成个文件习惯上命名为 [模块名-contextxml] 和[模块名osgicontextxml]modulenamecontextxml文件包含了不依赖与OSGi相关的bean的定义(可以理解为普通bean定义)modulenameosgicontextxml文件则定义那些引入或输出OSGi服务的bean这可能需要使用Spring Dynamic Modules的OSGi schema做为顶级命名空间取代spring的bean命名空间但这不是必须的

以下是 SpringContext的相关内容和配置主要意思如下

如果在SpringContext指定了配置文件那么extender将忽略 METAINF/spring 中的配置文件除非明确指定

可以用通配符例如SpringContext: osgi*;

createasynchronously=false(默认值是true) 使用同步方式创建该bundle的application context有一点需要注意同步创建application context的过程是在OSGi的事件线程中进行的它将阻塞这个线程的事件发送直到完成application context的初始化如果这个过程中发生了错误那么将出现一个FrameworkEventERROR但是bundle的状态仍然还是ACTIVE

waitfordependencies和timeout从字面意思就能看出来了

publishcontext:=false(默认值是true)不将application context作为一个服务发布

The SpringContext manifest header may be used to specify an alternate set of configuration files The resource paths are treated as relative resource paths and resolve to entries defined in the bundle and the set of attached fragments When the SpringContext header defines at least one configuration file location any files in METAINF/spring are ignored unless directly referenced from the SpringContext header

The syntax for the SpringContext header value is:

SpringContextValue ::= context ( context ) * context ::= path ( ; path ) * (; directive) *

This syntax is consistent with the OSGi Service Platform common header syntax defined in section of the OSGi Service Platform Core Specification

For example the manifest entry:

SpringContext: config/accountdatacontextxml config/accountsecuritycontextxml

will cause an application context to be instantiated using the configuration found in the files accountdatacontextxml and accountsecuritycontextxml in the bundle jar file

A number of directives are available for use with the SpringContext header These directives are:

createasynchronously (false|true): controls whether the application context is created asynchronously (the default) or synchronously

For example:

SpringContext: *;createasynchronously=false

Creates an application context synchronously using all of the *xml files contained in the METAINF/spring folder

SpringContext: config/accountdatacontextxml;createasynchrously:=false

Creates an application context synchronously using the config/accountdatacontextxml configuration file Care must be taken when specifying synchronous context creation as the application context will be created on the OSGi event thread blocking further event delivery until the context is fully initialized If an error occurs during the synchronous creation of the application context then a FrameworkEventERROR event is raised The bundle will still proceed to the ACTIVE state

waitfordependencies (true|false): controls whether or not application context creation should wait for any mandatory service dependencies to be satisfied before proceeding (the default) or proceed immediately without waiting if dependencies are not satisfied upon startup

For example:

SpringContext: config/osgi*xml;waitfordependencies:=false

Creates an application context using all the files matching osgi*xml in the config directory Context creation will begin immediately even if dependencies are not satisfied This essentially means that mandatory service references are treated as though they were optional clients will be injected with a service object that may not be backed by an actual service in the registry initially See section for more details

timeout (): the time to wait (in seconds) for mandatory dependencies to be satisfied before giving up and failing application context creation This setting is ignored if waitfordependencies:=false is specified The default is minutes ( seconds)

For example:

SpringContext: *;timeout:=

publishcontext (true|false): controls whether or not the application context object itself should be published in the OSGi service registry The default is to publish the context

For example:

SpringContext: *;publishcontext:=false

If there is no SpringContext manifest entry or no value is specified for a given directive in that entry then the directive takes on its default value

Required Spring Framework and Spring Dynamic Modules Bundles

The Spring Dynamic Modules project provides an number of bundle artifacts that must be installed in your OSGi platform in order for the Spring extender to function correctly:

Spring Dynamic Modules提供了很多现成的bundle要使用Spring extender必须将这些bundle安装到OSGi平台中:

The extender bundle itself orgspringframeworkosgiextender

The core implementation bundle for the Spring Dynamic Modules support orgsprire

The Spring Dynamic Modules i/o support library bundle orgspringframeworkosgiio

In addition the Spring Framework provides a number of bundles that are required to be installed As of release of the Spring Framework the Spring jars included in the Spring distribution are valid OSGi bundles and can be installed directly into an OSGi platform The minimum required set of bundles is:

另外spring还提供了很多它自己的bundle这些bundle可以直接被安装到OSGi平台中要使用spring的最低要求需要以下几个bundle:

springcorejar (bundle symbolic name orgre)

springcontextjar (bundle symbolic name orgntext)

springbeansjar (bundle symbolic name orgspringframeworkbeans)

springaopjar (bundle symbolic name orgspringframeworkaop)

In additional the following supporting library bundles are required OSGiready versions of these libraries are shipped with the Spring Dynamic Modules distribution

以下几个bundle是spring的依赖bundle可以在Spring Dynamic Modules的分发包中找到它们:

aopalliance

backportutil (for JDK )

cglibnodep

commonslogging (SLFJ version highly recommended)

Importing and Exporting packages

Refer to the OSGi Service Platform for details of the ImportPackage and ExportPackage manifest headers Your bundle will need an ImportPackage entry for every external package that the bundle depends on If your bundle provides types that other bundles need access to you will need ExportPackage entries for every package that should be available from outside of the bundle

这部份是关于OSGi平台MANIFEST中ImportPackage和ExportPackage的细节描述

               

上一篇:spring 整合strut2

下一篇:Spring Security学习总结一