IOS 手写签名:UberSignature

很早就有了自己写点技术博客的想法，正好最近在项目中用到了手写签名的功能，用到了Uber开源的UberSignature,发现代码结构思路也非常值得借鉴，希望能帮到需要使用的朋友。

效果图.png

UberSignature的架构

先截取一张UberSignature的类图

UberSignature截图.png

UBSignatureDrawingViewController：是该库的视图和控制层，是使用该库需要调用的唯一类！
UBCGPointHelpers:计算CGPoint常用的工具类
UBSignatureBezierProvider:负责提供临时的贝塞尔曲线
UBSignatureDrawingModel:主要的模型，与Provider交互提供绘制需要的点，提供一个将当前的存在图片中的贝塞尔曲线和临时贝塞尔曲线合成为新的图片的方法
UBSignatureDrawingModelAsync:UBSignatureDrawingModel的异步执行封装
UIBezierPath+UBWeightedPoint：该分类定义了UBWeightedPoint（给点添加一个weight属性，用来计算曲线的粗细）并且提供了将点生成闭合曲线的方法

UberSignature的使用

1.创建一个UBSignatureDrawingViewController对象,并且设置代理处理其中没有任何图像资料的情况。

@property(nonatomic,strong)UBSignatureDrawingViewController* signatureViewController;
self.signatureViewController = [[UBSignatureDrawingViewController alloc] initWithImage:nil];
self.signatureViewController.delegate=self;

2.将该对象作为一个子控制器，再将它的view添加到新视图控制器的view中去。

[self addChildViewController:self.signatureViewController];
[self.view addSubview:self.signatureViewController.view];

3.如果需要清除当前的签名，调用UBSignatureDrawingViewController的reset方法，如果获取当前签名的图片，调用UBSignatureDrawingViewController的fullSignatureImage方法。

[self.signatureViewController reset];
UIImage* signatureImage=[self.signatureViewController fullSignatureImage];

4.修改签名的颜色
self.signatureViewController.signatureColor=[UIColor customColor];

UberSignature的分析和学习

先由UBSignatureDrawingViewController切入

1.本类是外部调用的唯一类。只暴露了最少需要暴露的方法和变量。
构造方法，传入初始图片，图片可以为null
- (instancetype)initWithImage:(nullable UIImage *)image NS_DESIGNATED_INITIALIZER;
重置方法和获取签名图片的方法以及签名颜色

- (void)reset;
- (UIImage *)fullSignatureImage;
@property (nonatomic) UIColor *signatureColor;

不需要使用的构造方法使用了NS_UNAVAILABLE标志。（防止被错误的调用）

- (instancetype)initWithNibName:(nullable NSString *)nibNameOrNil bundle:(nullable NSBundle *)nibBundleOrNil NS_UNAVAILABLE;
- (nullable instancetype)initWithCoder:(NSCoder *)aDecoder NS_UNAVAILABLE;

2.视图结构。
UBSignatureDrawingViewController的视图由一个UIImageView和一个CAShapeLayer构成。
UIImageView负责显示已经保存的为图片的一些贝塞尔曲线，CAShapeLayer负责显示没有保存的赛贝尔曲线。两者组合显示当前的签名。
3.基本原理。
在UBSignatureDrawingViewController中重写了UIResponder中定义的触摸开始以及触摸移动方法，在方法中直接与UBSignatureDrawingModelAsync交互，将起点信息和所有触摸点位置传入，并且每一次触摸事件中都会从Model中更新视图（UIImageView的image和CAShapeLayer的path）。
UBSignatureDrawingModel是一个签名绘制模型。当触摸事件发生的时候更新一系列的点，并且生成更新UIImage和UIBezierPath。对外提供如下方法：

//更新点
- (void)updateWithPoint:(CGPoint)point;
//结束当前的连续的签名线条
- (void)endContinuousLine;
//清空当前的整个模型
- (void)reset;
//获取当前的整个签名图片
- (UIImage *)fullSignatureImage;
//签名的颜色
@property (null_resettable, nonatomic) UIColor *signatureColor;
//返回的UIImage对象的大小
@property (nonatomic) CGSize imageSize;
//已经完成且不可改变的签名图片
@property (nullable, nonatomic, readonly) UIImage *signatureImage;
//当前正在绘制的可以改变的签名部分
@property (nullable, nonatomic, readonly) UIBezierPath *temporarySignatureBezierPath;

内部核心方法如下：

//将图片和贝塞尔曲线合成新的图片
+ (UIImage *)_imageWithImageA:(UIImage *)imageA imageB:(UIImage *)imageB bezierPath:(UIBezierPath *)bezierPath color:(UIColor *)color size:(CGSize)size
{
    if (![self.class _isPositiveSize:size]) {
        return nil;
    }
    
    if (!imageA && !imageB && !bezierPath) {
        return nil;
    }
    
    CGRect imageFrame = CGRectMake(0, 0, size.width, size.height);
    //开始在指定的范围内绘制位图
    UIGraphicsBeginImageContextWithOptions(imageFrame.size, NO, 0);
    //将图片绘制在指定的区域内部
    [imageA drawInRect:imageFrame];
    [imageB drawInRect:imageFrame];
    //如果有路径将路径绘制在指定区域内
    if (bezierPath) {
        [color setStroke];
        [color setFill];
        
        [bezierPath stroke];
        [bezierPath fill];
    }
    //获取当前的位图对象
    UIImage *result = UIGraphicsGetImageFromCurrentImageContext();
    UIGraphicsEndImageContext();
    
    return result;
}

UBSignatureBezierProvider贝塞尔曲线的提供者
对外提供两个方法和一个代理：

//添加一个点到贝塞尔曲线中去
- (void)addPointToSignatureBezier:(CGPoint)point;
//将贝塞尔曲线重置
- (void)reset;
//通过该代理和UBSignatureDrawingModel对象沟通，将最新的曲线提供给模型对象
@property (nullable, nonatomic, weak) id<UBSignatureBezierProviderDelegate> delegate;
@protocol UBSignatureBezierProviderDelegate <NSObject>
//确保曲线绘制的实时性的回调
- (void)signatureBezierProvider:(UBSignatureBezierProvider *)provider updatedTemporarySignatureBezier:(nullable UIBezierPath *)temporarySignatureBezier;
//该条曲线绘制完成或者终止绘制的回调
- (void)signatureBezierProvider:(UBSignatureBezierProvider *)provider generatedFinalizedSignatureBezier:(UIBezierPath *)finalizedSignatureBezier;
@end

内部记录了四个点，一条贝塞尔曲线最多由四个点构成，超过四个点，或者手指主动离开，重新绘制下一条曲线。内部提供了一些方法计算点的weight（构建UBWeightedPoint，weight主要取决于手指移动的速度，有最大值和最小值），通过调用UIBezierPath+UBWeightedPoint分类的提供的绘制方法来获取闭合的临时以及完整地闭合贝塞尔曲线。

总结

UberSignature库每一个类的头文件公开的方法和属性是最精炼的，没有不必要的方法和属性开放出来，头文件的应用尽可能的少。每一个类的功能比较单一，用代理和block关联各个类，耦合度相对较小。