SBB Local Interface 详解

SBB Local Interface 详解

SBB Local Interface 的基本原理

SBB（Service Building Block）实体可以通过目标SBB的本地接口（SBB Local Interface）以同步的方式调用其他SBB实体。这种调用仅限于同一个JVM（Java虚拟机）内部的SBB对象之间，因为它们必须在同一个JVM内驻留。因此，称之为“SBB本地接口”。为了能够被同步调用，一个SBB需要声明SBB本地接口，该接口声明可以同步调用的方法。SBB本地对象（SBB Local Object）是SLEE实现的类的实例，这些类实现了SBB本地接口。

如何获取 SBB Local Object

SBB可以通过以下几种机制获取代表SBB实体的SBB本地对象：

1. 通过ChildRelation对象的create方法： 当SBB通过create方法创建子SBB实体时，返回的对象是实现了子SBB实体的SBB本地接口的对象。
2. 通过SbbContext的getSbbLocalObject方法： 通过SbbContext对象调用getSbbLocalObject方法获取。
3. 方法调用的返回值： 当一个SBB本地对象的方法调用时，SBB实体可以通过方法的返回值或者参数获得其他SBB本地对象。
4. 从CMP字段中获取： 可以从CMP（容器管理持久化）字段中检索到SBB本地对象。
5. 通过实现java.util.Collection接口的ChildRelation对象： ChildRelation对象及其迭代器可以访问SBB本地对象。

SBB Local Object 的功能

持有SBB本地对象的SBB对象可以执行以下操作：

1. 测试是否为相同的SBB实体： 通过SBB Local Object判断两个SBB Local Object是否代表相同的SBB实体。
2. 删除SBB实体： 删除SBB Local Object代表的SBB实体及其子实体。
3. 设置和获取事件的传递优先级： 可以设置和获取SBB实体的事件传递优先级。
4. 调用自定义方法： 可以调用SBB开发者定义的SBB本地对象的方法。
5. 在方法调用中传递SBB本地对象： SBB本地对象可以作为方法参数或返回值。
6. 存储在CMP字段中： SBB本地对象可以存储在CMP字段中以便持久化使用。

使用场景

典型场景：

1. 父SBB实体通过ChildRelation对象创建一个子SBB实体，create方法返回代表子SBB实体的SBB本地对象。
2. 父SBB或其他SBB可以通过SBB Local Object同步调用子SBB实体的自定义方法，SLEE系统会管理SBB实体的状态及其对象池。
3. 如果目标SBB实体已经删除，调用SBB本地对象的方法会抛出TransactionRolledbackLocalException异常。

Pass-by-reference 语义：
SBB本地接口的方法参数是以引用传递的，这意味着调用方和被调用方可能会引用相同的Java对象。因此，开发者需要注意同一对象的共享和修改。调用方如果不希望被调用方修改数据，应该在传递之前复制数据。

SbbLocalObject 接口详解

SbbLocalObject接口是所有SBB本地接口的基接口，SLEE提供其实现，具体方法包括：

1. isIdentical 方法： 判断两个SBB本地对象是否代表同一个SBB实体。必须在事务上下文中调用。
2. setSbbPriority 和 getSbbPriority 方法： 设置或获取SBB实体的事件传递优先级，优先级范围为-128到127。
3. remove 方法： 删除SBB实体及其子树，进行级联删除。

使用SBB Local Interface的场景示例

代码示例

1. 获取SBB本地对象：

public class ParentSbb implements Sbb {
    // 获取子SBB本地对象
    public ChildSbbLocalObject createChildSbb() throws Exception {
        ChildRelation childRelation = getChildRelation();  // 假设已有ChildRelation对象
        ChildSbbLocalObject child = (ChildSbbLocalObject) childRelation.create();
        return child;
    }
}

2. 调用SBB本地对象方法：

public class ParentSbb implements Sbb {
    public void invokeChildMethod() throws Exception {
        ChildSbbLocalObject child = createChildSbb();
        child.customMethod();  // 调用子SBB的自定义方法
    }
}

3. 设置SBB优先级：

public void setPriority(ChildSbbLocalObject child) {
    child.setSbbPriority((byte) 10);  // 设置优先级
}

配置示例

1. SBB XML配置：

<sbb>
    <sbb-name>ParentSbb</sbb-name>
    <sbb-vendor>com.example</sbb-vendor>
    <sbb-version>1.0</sbb-version>
    <sbb-alias>parent</sbb-alias>

    <sbb-classes>
        <sbb-class>com.example.sbb.ParentSbb</sbb-class>
    </sbb-classes>

    <sbb-child-relations>
        <child-relation>
            <name>childRelation</name>
            <sbb-ref>
                <sbb-name>ChildSbb</sbb-name>
                <sbb-vendor>com.example</sbb-vendor>
                <sbb-version>1.0</sbb-version>
            </sbb-ref>
        </child-relation>
    </sbb-child-relations>
</sbb>

小结

SBB Local Interface允许同一JVM中的SBB实体通过同步方式调用其他SBB实体。通过该机制，开发者可以创建更高效的服务块协作模型，同时提供事务处理和异常控制。