Declarative Services规范简介及应用

2024-01-15 08:38

本文主要是介绍Declarative Services规范简介及应用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Declarative Services 是一个面向服务的组件模型,它制订的目的是更方便地在OSGi服务平台上发布、查找、绑定服务,对服务进行动态管理,如监控服务状态以及解决服务之间的复 杂的依赖关系等问题。Declarative Services采用服务组件的延迟加载以及组件生命周期管理的方式来控制对于内存的占用以及启动的速度,很好的解决了传统的OSGi服务模型在开发和部 署比较复杂应用时内存占用大、启动慢等问题,并且对服务组件的描述采用XML来实现,十分便于用户理解和使用。在 Declarative Services 中,Component 可以是 Service 的提供者和引用者,一个 Component 可以提供 0 至多个 Service,也可以引用 0 至多个Service,并且采用component 方式封装 Service,方便了对 Service 的复用,从开发者的角度来看,该服务组件模型简化了在 OSGi 服务平台中的编程模型。

 

一、Component Satisfied 概念介绍
       在 Declarative Services 中,一个服务组件是通过XML文件描述其相关信息的,SCR(Service Component Runtime)根据服务组件配置文件控制着组件配置的激活(Activate)和钝化(Deactivate),服务组件配置文件包括如组件的类型、组 件的实现以及引用的服务等信息。

       在 Declarative Services 中,Component Satisfied 与 Component 的生命周期密切相关。如 Component 激活的前提条件之一就是 Component Satisfied,而在 Component 的运行过程中,出现 Unsatisfied 时,Component 将被钝化。主要由以下两点决定 Component 是否处于Satisfied 状态:

              1、Component 为 Enabled 状态,Component 的生命周期包含在引用它的 Bundle 应用的生命周期之内,只有在 Bundle 处于 Active 状态时,Component 才有可能为 Enabled 状态,在 Bundle处于 Stop 状态时,Bundle 中所有的 Component 都处在 Disabled 状态。Component 初始的Enabled 状态可以在服务组件配置文件中设定。

              2、Component 的配置是可以被引用和解析的,Component 中引用的 Service 也是 Satisfied 的,引用的 Service 至少有一个是处于可用状态的,或者引用的 Service 在服务组件配置文件里配置了可为 0 个可用状态的 Service。

       当上述两个条件中任何一个不满足时,组件配置将变为 Unsatisfied 状态,组件配置将被钝化。 

 

二、Component 介绍
       在 Bundle 启动时, Declarative Services 装载相应的服务组件配置文件,配置文件在MAINFEST.MF 文件的 Service-Component 属性指定,解析配置文件,获取服务组件引用的 Service ,如果判断组件 Satisfied 状态的两个条件满足时, Declarative Services 就认为这个组件是 Satisfied 的。

       Component的类型:
              1、Immediate Component
                     对于 Immediate Component,如果组件配置处于 Satisfied 状态,将会立即被激活,并且如果该配置指定了服务,那么 SCR 会注册该服务并且立即激活该服务组件。在SCR 激活组件配置时,实现服务组件类的 activate 方法将会被调用,在SCR钝化组件配置时,deactivate方法将会被调用。
              2、Delayed Component
                     对于 Delayed Component ,如果组件配置处于Satisfied状态,该组件并不会立即被激活,Declarative Services 会根据组件配置文件中的 Service 的配置,注册相应的Service 的信息,直到该服务组件被请求时, Declarative Services 才会激活该组件配置 。 Delayed Component 延迟了 Component 类的创建,当该服务组件的服务收到请求时,该 Component 类的 activate 方法才会被调用。如果一个 Component 不是 Factory Component,并且在其组件配置文件中指定了服务,组件的 immediate 属性设置为 false,那么该组件就是 Delayed Component。
              3、Factory Component
                     通过在组件配置文件中设置 Component 的 factory 属性,将 Component 声明为 Factory Component。该组件在激活后注册的是一个 Component Factory 服务,只有在调用 Component Factory 的 newInstance 方法后才会激活相应的各个组件,每一次调用 newInstance 方法,都会创建和激活一个新的组件配置。如果在组件配置文件中声明了服务,那么在该组件激活之前,声明的服务被注册。 

 

三、服务组件开发、发布

     1、下载Declarative Services的Equinox实现(如org.eclipse.equinox.ds_1.0.0.v20060601a.jar),将该文件放到 Eclipse安装目录的plugins下。使用Eclipse中的Plug-in项目向导来创建一个项目(参考OSGI系列相关文章)。

 

     2、创建服务接口及服务实现类

Java代码   收藏代码
  1. public   interface  UserManager {  
  2.     public   abstract  String sayHello(String username);  
  3. }  

 

Java代码   收藏代码
  1. public   class  UserManagerImpl  implements  UserManager {  
  2.     public  String sayHello(String username){  
  3.         return   "你好,"  + username;  
  4.     }  
  5. }  

 

    3、在顶级目录下创建一个名为OSGI-INF的文件夹,并新建一个名为UserManager.xml的组件配置文件

Xml代码   收藏代码
  1. <? xml   version = "1.0"   encoding = "UTF-8" ?>   
  2. < component   name = "userManager" >       
  3.     <!-- Implementation元素定义了实现该服务接口的组件类名 -->   
  4.     < implementation   class = "com.cjm.bundle.UserManagerImpl" />     
  5.       
  6.     <!-- Service元素定义了所提供服务的接口 -->   
  7.     < service >        
  8.         < provide   interface = "com.cjm.bundle.UserManager" />    
  9.     </ service >   
  10. </ component >   

 

    4、MANIFEST.MF文件内容

Xml代码   收藏代码
  1. Manifest-Version: 1.0  
  2. Bundle-ManifestVersion: 2  
  3. Bundle-Name: UserValidatorBundle  
  4. Bundle-SymbolicName: UserValidatorBundle  
  5. Bundle-Version: 1.0.0  
  6. Service-Component: OSGI-INF/UserManager.xml  
  7. Import-Package: org.osgi.framework;version = "1.3.0"   
  8. Export-Package: com.cjm.bundle;version = "1.0.0"   

其中,Service-Component 属性指定了该 Bundle 应用的服务组件配置文件,在该配置文件中声明服务并且指定了实现该服务的组件。Export-Package 属性指定了该 Bundle 输出的共享包,该属性可以使其他的 Bundle 引用所定义的服务接口。

 

四、服务组件获取

      在 Declarative Services 中,Component 所引用的服务,称为 Target Service。在组件实现类中,有两种策略可以获得在组件配置文件里指定的 Target Service,是事件策略和 Lookup 策略。

 

      在服务组件激活的过程中,SCR 必须将组件配置文件里指定的 Target Service 绑定到组件配置中。事件策略主要适用于服务组件所引用的 Target Service 处在动态变化中。

 

     1、组件接口及实现类 

Java代码   收藏代码
  1. public   interface  UserManagerClient {  
  2.     public  UserManager getUserManager();  
  3. }  

 

Java代码   收藏代码
  1. public   class  UserManagerClientImpl  implements  UserManagerClient{  
  2.     UserManager userManager;  
  3.       
  4.     /**  
  5.      * 采用事件策略绑定服务。当获取当前Bundle的服务时触发该方法。  
  6.      */   
  7.     public   void  bindService(UserManager userManager){  
  8.         this .userManager = userManager;  
  9.         System.out.println("UserManagerClientImpl bindService" );  
  10.     }  
  11.       
  12.     /**  
  13.      * 采用事件策略取消绑定。当引用该Bundle服务的Bundle停止时触发该方法。  
  14.      */   
  15.     public   void  unbindService(UserManager userManager){  
  16.         this .userManager =  null ;  
  17.         System.out.println("UserManagerClientImpl unbindService" );  
  18.     }  
  19.   
  20.     public  UserManager getUserManager() {  
  21.         return  userManager;  
  22.     }  
  23.       
  24.     /**  
  25.      * 采用 Lookup 策略取得服务  
  26.      */   
  27.     public   void  activate(ComponentContext context){  
  28.         UserManager userManager = (UserManager)context.locateService("userManager" );  
  29.         System.out.println(userManager.sayHello("美女" ));  
  30.     }  
  31.       
  32.     public   void  deactivate(ComponentContext context){  
  33.         System.out.println("bye bye 美女" );  
  34.     }  
  35. }  

    启动 顺序 :先调用bind方法,再调用activate方法。

    停止顺序:先调用deactivate方法,最后调用unbind方法。

 

     2、组件配置文件内容

Xml代码   收藏代码
  1. <? xml   version = "1.0"   encoding = "UTF-8" ?>   
  2. < component   name = "userManagerClient" >     
  3.     < implementation   class = "com.cjm.bundle.user.service.web.UserManagerClientImpl" />      
  4.       
  5.     < service >        
  6.         < provide   interface = "com.cjm.bundle.user.service.web.UserManagerClient" />     
  7.     </ service >   
  8.       
  9.     <!--   
  10.         reference元素定义了该组件所引用的服务接口。  
  11.           
  12.         cardinality:  
  13.             0..1:可选和单个,“0或1”   
  14.             1..1:有且仅有一个,“只有一个”  (默认)   
  15.             0..n:可选和多个,“0到多”   
  16.             1..n:必须或者多个,“至少一个”   
  17.   
  18.         policy:  
  19.             static(默认)  如果引用的 Target Service 发生了变化,那么组件配置会被重新装载并激活。  
  20.             dynamic   SCR在不钝化组件配置的情况下可以改变绑定的 Target Service,即调用其中的unbind和bind方法。  
  21.   
  22.         target:根据属性值过滤组件服务  
  23.      -->   
  24.     < reference   name = "userManager"    
  25.         interface = "com.cjm.bundle.UserManager"    
  26.         bind = "bindService"    
  27.         unbind = "unbindService"    
  28.         cardinality = "0..1"    
  29.         policy = "static"   
  30.         target = "(component.version=1.0)" />   
  31.       
  32.     <!-- 组件属性的配置 -->   
  33.     < property   name = "component.version" > 1.0 </ property >   
  34.     < property   name = "component.canuse"   type = "Boolean" > true </ property >   
  35.     < properties   entry = "OSGI-INF/config.properties" />   
  36. </ component >   

 

     3、MANIFEST.MF文件内容

Xml代码   收藏代码
  1. Manifest-Version: 1.0  
  2. Bundle-ManifestVersion: 2  
  3. Bundle-Name: UserValidatorWebBundle  
  4. Bundle-SymbolicName: UserValidatorWebBundle  
  5. Bundle-Version: 1.0.0  
  6. Service-Component: OSGI-INF/UserManagerClient.xml  
  7. Import-Package: com.cjm.bundle, org.osgi.framework;version = "1.3.0"   
  8. Export-Package: com.cjm.bundle.user.service.web  

 

     4、消费服务

Java代码   收藏代码
  1. public   class  TestActivator  implements  BundleActivator {  
  2.     public   void  start(BundleContext context)  throws  Exception {  
  3.         ServiceReference serviceReference = context.getServiceReference(UserManagerClient.class .getName());  
  4.         UserManagerClient client = (UserManagerClient)context.getService(serviceReference);  
  5.         if (client!= null ){  
  6.             System.out.println("TestActivator: "  + client.getUserManager().sayHello( "cjm" ));  
  7.         }  
  8.     }  
  9.   
  10.     public   void  stop(BundleContext context)  throws  Exception {  
  11.         System.out.println("TestActivator stop" );  
  12.     }  
  13. }  

 

分享到:

这篇关于Declarative Services规范简介及应用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/608292

相关文章

利用Python操作Word文档页码的实际应用

《利用Python操作Word文档页码的实际应用》在撰写长篇文档时,经常需要将文档分成多个节,每个节都需要单独的页码,下面:本文主要介绍利用Python操作Word文档页码的相关资料,文中通过代码... 目录需求:文档详情:要求:该程序的功能是:总结需求:一次性处理24个文档的页码。文档详情:1、每个

Java中的分布式系统开发基于 Zookeeper 与 Dubbo 的应用案例解析

《Java中的分布式系统开发基于Zookeeper与Dubbo的应用案例解析》本文将通过实际案例,带你走进基于Zookeeper与Dubbo的分布式系统开发,本文通过实例代码给大家介绍的非常详... 目录Java 中的分布式系统开发基于 Zookeeper 与 Dubbo 的应用案例一、分布式系统中的挑战二

Java Docx4j类库简介及使用示例详解

《JavaDocx4j类库简介及使用示例详解》Docx4j是一个强大而灵活的Java库,非常适合需要自动化生成、处理、转换MicrosoftOffice文档的服务器端或后端应用,本文给大家介绍Jav... 目录1.简介2.安装与依赖3.基础用法示例3.1 创建一个新 DOCX 并添加内容3.2 读取一个已存

Java 缓存框架 Caffeine 应用场景解析

《Java缓存框架Caffeine应用场景解析》文章介绍Caffeine作为高性能Java本地缓存框架,基于W-TinyLFU算法,支持异步加载、灵活过期策略、内存安全机制及统计监控,重点解析其... 目录一、Caffeine 简介1. 框架概述1.1 Caffeine的核心优势二、Caffeine 基础2

使用Node.js和PostgreSQL构建数据库应用

《使用Node.js和PostgreSQL构建数据库应用》PostgreSQL是一个功能强大的开源关系型数据库,而Node.js是构建高效网络应用的理想平台,结合这两个技术,我们可以创建出色的数据驱动... 目录初始化项目与安装依赖建立数据库连接执行CRUD操作查询数据插入数据更新数据删除数据完整示例与最佳

Java中最全最基础的IO流概述和简介案例分析

《Java中最全最基础的IO流概述和简介案例分析》JavaIO流用于程序与外部设备的数据交互,分为字节流(InputStream/OutputStream)和字符流(Reader/Writer),处理... 目录IO流简介IO是什么应用场景IO流的分类流的超类类型字节文件流应用简介核心API文件输出流应用文

Spring Security简介、使用与最佳实践

《SpringSecurity简介、使用与最佳实践》SpringSecurity是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架,本文给大家介绍SpringSec... 目录一、如何理解 Spring Security?—— 核心思想二、如何在 Java 项目中使用?——

PHP应用中处理限流和API节流的最佳实践

《PHP应用中处理限流和API节流的最佳实践》限流和API节流对于确保Web应用程序的可靠性、安全性和可扩展性至关重要,本文将详细介绍PHP应用中处理限流和API节流的最佳实践,下面就来和小编一起学习... 目录限流的重要性在 php 中实施限流的最佳实践使用集中式存储进行状态管理(如 Redis)采用滑动

深入浅出Spring中的@Autowired自动注入的工作原理及实践应用

《深入浅出Spring中的@Autowired自动注入的工作原理及实践应用》在Spring框架的学习旅程中,@Autowired无疑是一个高频出现却又让初学者头疼的注解,它看似简单,却蕴含着Sprin... 目录深入浅出Spring中的@Autowired:自动注入的奥秘什么是依赖注入?@Autowired

Java Stream 并行流简介、使用与注意事项小结

《JavaStream并行流简介、使用与注意事项小结》Java8并行流基于StreamAPI,利用多核CPU提升计算密集型任务效率,但需注意线程安全、顺序不确定及线程池管理,可通过自定义线程池与C... 目录1. 并行流简介​特点:​2. 并行流的简单使用​示例:并行流的基本使用​3. 配合自定义线程池​示