iOS 扩展

cn

Module 扩展

swift 扩展 module

Weex SDK 只提供渲染，而不是其他的能力，如果你需要 像网络，图片，URL跳转这些特性，需要自己动手实现他们 例如，如果你想实现一个url地址跳转函数，你可以按照如下步骤实现一个 Module

自定义module的步骤

  1. 自定义的module类 必须实现 WXModuleProtocol
  2. 必须添加宏WX_EXPORT_METHOD, 它可以被weex识别，它的参数是 JavaScript调用 module指定方法的参数
  3. 添加@synthesized weexInstance，每个moudle对象被绑定到一个指定的实例上
  4. Module 方法会在UI线程中被调用，所以不要做太多耗时的任务在这里，如果要在其他线程执行整个module 方法，需要实现WXModuleProtocol中- (NSThread *)targetExecuteThread的方法，这样，分发到这个module的任务会在指定的线程中运行
  5. Weex 的参数可以是 String 或者Map
  6. Module 支持返回值给 JavaScript中的回调，回调的类型是WXModuleCallback,回调的参数可以是String或者Map

    @implementation WXEventModule
    @synthesize weexInstance;
       WX_EXPORT_METHOD(@selector(openURL:callback))

    - (void)openURL:(NSString *)url callback:(WXModuleCallback)callback
    {
        NSString *newURL = url;
        if ([url hasPrefix:@"//"]) {
            newURL = [NSString stringWithFormat:@"http:%@", url];
        } else if (![url hasPrefix:@"http"]) {
           newURL = [NSURL URLWithString:url relativeToURL:weexInstance.scriptURL].absoluteString;
        }

        UIViewController *controller = [[WXDemoViewController alloc] init];
        ((WXDemoViewController *)controller).url = [NSURL URLWithString:newURL];

        [[weexInstance.viewController navigationController] pushViewController:controller animated:YES];
        callback(@{@"result":@"success"});
    }

    @end

注册 module

通过调用 WXSDKEngine 中的 registerModule:withClass方法来注册自己的module


      WXSDKEngine.h
      /**
         *  @abstract Registers a module for a given name
         *  @param name The module name to register
         *  @param clazz  The module class to register
        **/
        + (void)registerModule:(NSString *)name withClass:(Class)clazz;

        [WXSDKEngine registerModule:@"event" withClass:[WXEventModule class]];

使用自己的module

这里的 require 里面的event 就是在 上一步调用registerModule:注册module 时候的name

  var eventModule = require('@weex-module/event'); 
  eventModule.openURL('url',function(ret) {   
      nativeLog(ret);
  });

handler 扩展

Weex SDK没有 图片下载，navigation 操作的能力，请大家自己实现这些 protocol

WXImgLoaderProtocol

weexSDK 没有图片下载的能力，需要实现 WXImgLoaderProtocol,参考下面的例子


    WXImageLoaderProtocol.h
    @protocol WXImgLoaderProtocol <WXModuleProtocol>

    /**
      * @abstract Creates a image download handler with a given URL
      * @param imageUrl The URL of the image to download
      * @param imageFrame  The frame of the image you want to set
      * @param options : The options to be used for this download
      * @param completedBlock : A block called once the download is completed.
        image : the image which has been download to local.
        error : the error which has happened in download.
        finished : a Boolean value indicating whether download action has finished.
     */
     -(id<WXImageOperationProtocol>)downloadImageWithURL:(NSString *)url imageFrame:(CGRect)imageFrame userInfo:(NSDictionary *)options completed:(void(^)(UIImage *image,  NSError *error, BOOL finished))completedBlock;
     @end

实现上述协议


    @implementation WXImgLoaderDefaultImpl
    #pragma mark -
    #pragma mark WXImgLoaderProtocol

    - (id<WXImageOperationProtocol>)downloadImageWithURL:(NSString *)url imageFrame:(CGRect)imageFrame userInfo:(NSDictionary *)userInfo completed:(void(^)(UIImage *image,  NSError *error, BOOL finished))completedBlock
    {
        if ([url hasPrefix:@"//"]) {
            url = [@"http:" stringByAppendingString:url];
        }
        return (id<WXImageOperationProtocol>)[[SDWebImageManager sharedManager] downloadImageWithURL:[NSURL URLWithString:url] options:0 progress:^(NSInteger receivedSize, NSInteger expectedSize) {     
        } completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType, BOOL finished, NSURL *imageURL) {
        if (completedBlock) {
            completedBlock(image, error, finished);
        }
        }];
    }
    @end

handler注册

你可以通过WXSDKEngine 中的 registerHandler:withProtocol注册handler


      WXSDKEngine.h
      /**
        * @abstract Registers a handler for a given handler instance and specific protocol
        * @param handler The handler instance to register
        * @param protocol The protocol to confirm
        */
       + (void)registerHandler:(id)handler withProtocol:(Protocol *)protocol;

       [WXSDKEngine registerHandler:[WXImgLoaderDefaultImpl new] withProtocol:@protocol(WXImgLoaderProtocol)];

iOS原生组件定制

Component 扩展

虽然WeexSDK中有很多的native的Component，但这有可能并不能满足你的需求。在之前你可能已经写了一些很酷炫native的组件，想包装一下，导入到Weex中，因此我们提供了让开发者实现自己的native Component 下面将以WeexSDK 中已经存在的 Component：image为例子，介绍一下如何构建一个native Component. 假设你已经了解IOS开发

注册 Component

注册一个component比较简单，调用 WXSDKEngine 中的 registerComponent:withClass:方法，传入组件的标签名称，还有对应的class 然后你可以创建一个 WXImageComponent 表示image组件的实现在.we 文件中，只需要写

[WXSDKEngine registerComponent:@"image" withClass:[WXImageComponent class]];

<image></image>

添加属性

现在我们要做一些让image component更加强大的事情。既然作为一个图片的component，那它应该要有源，给他加上一个 src的属性，同时给它加上一个resize的属性（可以配置的有contain/cover/stretch）

@interface WXImageComponent ()

@property (nonatomic, strong) NSString *imageSrc;
@property (nonatomic, assign) UIViewContentMode resizeMode;

@end

component中所有的style，attribute，events都会被传递到 Component的初始化方法中，所以，你可以在初始化方法中存储你感兴趣的一些属性值

@implementation WXImageComponent

- (instancetype)initWithRef:(NSString *)ref type:(NSString *)type styles:(NSDictionary *)styles attributes:(NSDictionary *)attributes events:(NSArray *)events weexInstance:(WXSDKInstance *)weexInstance
{
    if (self = [super initWithRef:ref type:type styles:styles attributes:attributes events:events weexInstance:weexInstance]) {
        _imageSrc = [WXConvert NSString:attributes[@"src"]];
        _resizeMode = [WXConvert UIViewContentMode:attributes[@"resize"]];
    }

    return self;
}

@end

attribute中拿到的值的类型都是id,我们可以用转换方法把它转换到任何值。Weex SDK提供了一些基础的转换方法，可以参考 WXConvert类，或者你可以添加自己的转换函数。

Hooking 渲染生命周期

native 的component 是由Weex管理的，weex 创建，布局，渲染，销毁。weex的component生命周期都是可以hook的，你可以在这些生命周期中去做自己的事情

方法 描述
initWithRef:type:... 用给定的属性初始化一个component.
layoutDidFinish 在component完成布局时候会调用.
loadView 创建component管理的view.
viewWillLoad 在component的view加载之前会调用.
viewDidLoad 在component的view加载完之后调用.
viewWillUnload 在component的view被释放之前调用.
viewDidUnload 在component的view被释放之后调用.
updateStyles: 在component的style更新时候调用.
updateAttributes: 在component的attribute更新时候调用.
addEvent: 给component添加event的时候调用.
removeEvent: 在event移除的时候调用.

在image component的例子里面，如果我们需要我们自己的image view 的话，可以复写 loadView这个方法.

- (UIView *)loadView
{
    return [[WXImageView alloc] init];
}

现在我们使用WXImageView渲染 image component。

作为一个image component，我们需要拿到服务器图片，而且把它设置进image view 里. 这个操作可以在 viewDidLoad 方法中做，这个方法是在view已经被创建而且加载了时候weex SDK会调用到，而且viewDidLoad这个方法是你做额外初始化工作比如改变content mode(也就是设置resize) 的最好时间.

- (void)viewDidLoad
{
    UIImageView *imageView = (UIImageView *)self.view;
    imageView.contentMode = _resizeMode;
    imageView.userInteractionEnabled = YES;
    imageView.clipsToBounds = YES;
    imageView.exclusiveTouch = YES;

    // Do your image fetching and updating logic
}

如果可以改变image的src,也可以hook updateAttributes:方法来做属性更新操作，当updateAttributes:或者 updateStyles:被调用的时候， component的view 已经加载完成。

- (void)updateAttributes:(NSDictionary *)attributes
{
    if (attributes[@"src"]) {
        _imageSrc = [WXConvert NSString:attributes[@"src"]];
        // Do your image updating logic
    }

    if (attributes[@"resize"]) {
        _resizeMode = [WXConvert UIViewContentMode:attributes[@"resize"]];
        self.view.contentMode = _resizeMode;
    }
}

或许你需要考虑更多的生命周期方法去Hook，当布局完成时候，像layoutDidFinish，如果你想了解更多，可以参考一下WXComponent.h 声明的方法 现在你可以用在任何 .we文件里面使用 <image>，而且可以加上image的属性

<image style="your-custom-style" src="image-remote-source" resize="contain/cover/stretch"></image>

results matching ""

    No results matching ""