Declarative Services规范简介及应用

2024-01-15 08:38
文章标签 应用 简介 services 规范 declarative

本文主要是介绍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中随机休眠技术原理与应用详解

Python中随机休眠技术原理与应用详解

《Python中随机休眠技术原理与应用详解》在编程中,让程序暂停执行特定时间是常见需求,当需要引入不确定性时,随机休眠就成为关键技巧,下面我们就来看看Python中随机休眠技术的具体实现与应用吧... 目录引言一、实现原理与基础方法1.1 核心函数解析1.2 基础实现模板1.3 整数版实现二、典型应用场景2
阅读更多...
Python Dash框架在数据可视化仪表板中的应用与实践记录

Python Dash框架在数据可视化仪表板中的应用与实践记录

《PythonDash框架在数据可视化仪表板中的应用与实践记录》Python的PlotlyDash库提供了一种简便且强大的方式来构建和展示互动式数据仪表板,本篇文章将深入探讨如何使用Dash设计一... 目录python Dash框架在数据可视化仪表板中的应用与实践1. 什么是Plotly Dash？1.1
阅读更多...
Android Kotlin 高阶函数详解及其在协程中的应用小结

Android Kotlin 高阶函数详解及其在协程中的应用小结

《AndroidKotlin高阶函数详解及其在协程中的应用小结》高阶函数是Kotlin中的一个重要特性,它能够将函数作为一等公民（First-ClassCitizen）,使得代码更加简洁、灵活和可... 目录1. 引言2. 什么是高阶函数？3. 高阶函数的基础用法3.1 传递函数作为参数3.2 Lambda
阅读更多...
Java中&和&&以及|和||的区别、应用场景和代码示例

Java中&和&&以及|和||的区别、应用场景和代码示例

《Java中&和&&以及|和||的区别、应用场景和代码示例》：本文主要介绍Java中的逻辑运算符&、&&、|和||的区别,包括它们在布尔和整数类型上的应用,文中通过代码介绍的非常详细,需要的朋友可... 目录前言1. & 和 &&代码示例2. | 和 ||代码示例3. 为什么要使用 & 和 | 而不是总是使
阅读更多...
Python循环缓冲区的应用详解

Python循环缓冲区的应用详解

《Python循环缓冲区的应用详解》循环缓冲区是一个线性缓冲区,逻辑上被视为一个循环的结构,本文主要为大家介绍了Python中循环缓冲区的相关应用,有兴趣的小伙伴可以了解一下... 目录什么是循环缓冲区循环缓冲区的结构python中的循环缓冲区实现运行循环缓冲区循环缓冲区的优势应用案例Python中的实现库
阅读更多...
SpringBoot整合MybatisPlus的基本应用指南

SpringBoot整合MybatisPlus的基本应用指南

《SpringBoot整合MybatisPlus的基本应用指南》MyBatis-Plus,简称MP,是一个MyBatis的增强工具,在MyBatis的基础上只做增强不做改变,下面小编就来和大家介绍一下... 目录一、MyBATisPlus简介二、SpringBoot整合MybatisPlus1、创建数据库和
阅读更多...
python中time模块的常用方法及应用详解

python中time模块的常用方法及应用详解

《python中time模块的常用方法及应用详解》在Python开发中,时间处理是绕不开的刚需场景,从性能计时到定时任务,从日志记录到数据同步,时间模块始终是开发者最得力的工具之一,本文将通过真实案例... 目录一、时间基石：time.time()典型场景：程序性能分析进阶技巧：结合上下文管理器实现自动计时
阅读更多...
Java逻辑运算符之&&、|| 与&、 |的区别及应用

Java逻辑运算符之&&、|| 与&、 |的区别及应用

《Java逻辑运算符之&&、||与&、|的区别及应用》：本文主要介绍Java逻辑运算符之&&、||与&、|的区别及应用的相关资料,分别是&&、||与&、|,并探讨了它们在不同应用场景中... 目录前言一、基本概念与运算符介绍二、短路与与非短路与：&& 与 & 的区别1. &&：短路与（AND）2. &：非短
阅读更多...
通过Python脚本批量复制并规范命名视频文件

通过Python脚本批量复制并规范命名视频文件

《通过Python脚本批量复制并规范命名视频文件》本文介绍了如何通过Python脚本批量复制并规范命名视频文件,实现自动补齐数字编号、保留原始文件、智能识别有效文件等功能,听过代码示例介绍的非常详细,... 目录一、问题场景：杂乱的视频文件名二、完整解决方案三、关键技术解析1. 智能路径处理2. 精准文件名
阅读更多...
Spring AI集成DeepSeek三步搞定Java智能应用的详细过程

Spring AI集成DeepSeek三步搞定Java智能应用的详细过程

《SpringAI集成DeepSeek三步搞定Java智能应用的详细过程》本文介绍了如何使用SpringAI集成DeepSeek,一个国内顶尖的多模态大模型,SpringAI提供了一套统一的接口,简... 目录DeepSeek 介绍Spring AI 是什么？Spring AI 的主要功能包括1、环境准备2
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2