Tag Archives: Framework

iOS Universal Framework 빌드하기

이 글은 [XCode 6 Framework 만들기] 의 내용을 보충하기 위해서 작성된 글입니다. 먼저 iOS의 Framework 만드는 방법에 대한 글을 숙지 하신 뒤에 이 글을 참고하시기 바랍니다.

기존에 작성 되었던 “XCode 6 Framework 만들기” 글은 일반적으로 다른 어플리케이션에서 사용 가능한 Framework를 만드는 방법에 대해 정리된 블로그 글이었습니다. 하지만 배포 가능한 형태의 Framework를 만들기 위해서는 몇가지 더 신경써야 할 부분이 있습니다. 그런 부분에 대해서 정리를 해보겠습니다.

ios_fat_framework_01

먼저 Build Settings 에서 위와 같이 설정이 되어있는지 확인하셔야 합니다. Valid Architectures 에는 지원하고자 하는 아키텍쳐를 선택해 주시면 되며 너무 많은 아키텍쳐를 선택하는 것은 Framework의 용량을 커지게 한다는 문제점을 가지고 있습니다.

ios_fat_framework_02

마찬가지로 Build Settings 혹은 General 설정에서 볼 수 있는 Deployment Target에 대해서 확인이 필요합니다. Bitcode를 정상적으로 지원하기 위해서는 최소 6.0 이상으로 설정하셔야 합니다.

ios_fat_framework_03

이 설정은 본인이 진행하시는 프로젝트의 상황에 맞게 설정하시면 됩니다. 기본적으로 Dynamic Library로 설정이 되어있으며 이는 Framework가 어플리케이션의 런타임에 링크되어 실행된다는 것을 의미합니다. 추가로 위에서 보여지는 Static Library의 경우에는 어플리케이션의 컴파일 시점에 링크되어 함께 컴파일됩니다. 하지만 Static Library는 이미지와 같은 리소스 파일들을 포함할 수 없다는 문제가 있습니다. 주로 이미지를 담고 있는 Media Bundle 파일을 함께 제공하는 방법을 사용하고 있습니다.

이제 Framework 프로젝트가 준비가 완료된 것 같습니다. 이제 다양한 아키텍쳐를 지원할 수 있도록 빌드를 수행해야 합니다. 다양한 방법이 있겠지만 저는 별도의 스크립트를 프로젝트의 루트에 두어 스크립트를 통해 빌드를 합니다. 제가 자주 사용하는 스크립트는 다음과 같습니다.

#!/bin/sh

SUPPORTED_PLATFORMS="iphoneos iphonesimulator"
PROJECT_NAME="HelloFramework"
CONFIGURATION="Release"
#CONFIGURATION="Debug"
CURRENT_WORKING_DIR=`pwd`
BUILD_DIR="${CURRENT_WORKING_DIR}/build"

for PLATFORM in $SUPPORTED_PLATFORMS; do
  xcodebuild -target "${PROJECT_NAME}" -configuration "${CONFIGURATION}" -sdk "${PLATFORM}" \
    ENABLE_BITCODE=YES ONLY_ACTIVE_ARCH=NO BUILD_DIR="${BUILD_DIR}" CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO clean build
done

cp -R "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework" "${BUILD_DIR}/"

lipo -create -output "${BUILD_DIR}/${PROJECT_NAME}.framework/${PROJECT_NAME}" \
  "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework/${PROJECT_NAME}" \
  "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/${PROJECT_NAME}"

echo "Fat Framework Built : ${BUILD_DIR}/${PROJECT_NAME}.framework"

이제 만들어진 스크립트를 실행해 보겠습니다.

...

Touch build/Release-iphonesimulator/HelloFramework.framework
    cd /Users/theeye/HelloFramework
    export PATH="/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/usr/bin:/Applications/Xcode.app/Contents/Developer/usr/bin:/usr/local/bin::/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/share/dotnet:/Library/Frameworks/Mono.framework/Versions/Current/Commands"
    /usr/bin/touch -c /Users/theeye/HelloFramework/build/Release-iphonesimulator/HelloFramework.framework

** BUILD SUCCEEDED **

Fat Framework Built : /Users/theeye/HelloFramework/build/HelloFramework.framework

정상적으로 빌드가 되었는지 확인을 해보겠습니다.

$ cd cd build/HelloFramework.framework/
$ lipo -info HelloFramework 
Architectures in the fat file: HelloFramework are: armv7 i386 x86_64 arm64

다양한 아키텍쳐가 포함된 Universal(Fat) Framework 가 만들어진것을 확인할 수 있습니다.

참고용 Framework 프로젝트 : HelloFramework_UniversalFramework

iOS Framework 이미지 리소스 사용하기

Cocoa Touch Framework가 자기 자신이 가진 이미지 리소스에 접근하기 위해서는 몇가지 추가적인 조치가 필요합니다. UIImage클래스가 가진 imageNamed 메소드를 사용하면 리소스의 이름만으로 이미지를 불러올 수 있지만 MainBundle 기준으로 동작하기 때문에 불러오지 못하는 경우가 발생합니다. 한번 확인을 해보도록 하겠습니다. 이 글은 [XCode 6 Framework 만들기]의 결과물을 활용합니다.

ios_framework_image_01

먼저 테스트로 사용할 이미지 파일을 추가합니다. 저는 골프GTI이미지를 사용해 보겠습니다. 그리고 Person 클래스에 간단하게 이미지를 반환하는 메소드를 추가해 보겠습니다.

#import <UIKit/UIKit.h>

@interface Person : NSObject

- (instancetype)initWithName:(NSString *)name age:(int)age;
- (void)info;
- (UIImage *)image;

@end
#import "Person.h"

@interface Person ()

@property(strong, nonatomic) NSString *name;
@property(nonatomic) int age;

@end

@implementation Person

- (instancetype)initWithName:(NSString *)name age:(int)age
{
    if(self = [super init]) {
        self.name = name;
        self.age = age;
    }
    return self;
}

- (void)info
{
    NSLog(@"The person's name is %@ and his age is %d", self.name, self.age);
}

- (UIImage *)image
{
    return [UIImage imageNamed:@"golf"];
}

@end

image라는 메소드를 하나 추가했습니다. 그 내용은 golf라는 이름의 이미지를 로드하여 반환다는것이 전부입니다. 이번에는 ViewController.m에 이미지를 받아 출력하는 코드를 추가합니다.

#import "ViewController.h"
#import <HelloFramework/HelloFramework.h>

@interface ViewController ()

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    
    Person *person = [[Person alloc] initWithName:@"Hello" age:19];
    [person info];

    // 이미지를 화면에 출력합니다.
    UIImageView *imageView = [[UIImageView alloc] initWithImage:[person image]];
    [self.view addSubview:imageView];
    
}

- (void)didReceiveMemoryWarning {
    [super didReceiveMemoryWarning];
    // Dispose of any resources that can be recreated.
}

@end

이제 시뮬레이터 환경에서 한번 실행해 보도록 하겠습니다.

ios_framework_image_02

아무것도 화면에 출력되지 않는군요… 이미지를 정상적으로 로드하지 못하여 발생하는 문제입니다. MainBundle이 아닌 Framework의 Bundle에서 이미지를 읽어오도록 코드를 수정해 보도록 하겠습니다. Framework 프로젝트의 Person.m의 내용을 수정합니다. 수정후에는 Build를 수행하여 HelloApp 프로젝트에 적용하는것을 잊지 맙시다.

- (UIImage *)image
{
    NSBundle *frameworkBundle = [NSBundle bundleForClass:[self class]];
    return [UIImage imageNamed:@"golf" inBundle:frameworkBundle compatibleWithTraitCollection:nil];
}

위와 같은 방법으로 Framework 자기 자신의 Bundle에 속해있는 리소스에 접근할 수 있게 됩니다. 하지만 위의 API는 iOS 8부터 지원하는 API이므로 적절하지 않아 보입니다. 버전에 구애받지 않고 사용할 수 있는 방법은 다음과 같은 방법이 있습니다.

- (UIImage *)image
{
    NSBundle *frameworkBundle = [NSBundle bundleForClass:[self class]];
    NSString *imagePath = [frameworkBundle pathForResource:@"golf" ofType:@"jpg"];
    return [UIImage imageWithContentsOfFile:imagePath];
}

이제 확인을 해보겠습니다. 다시 한번 Framework를 빌드하고 시뮬레이터를 실행해 보겠습니다.

ios_framework_image_03

크기가 적절하게 이쁘게 나오지는 않았지만 정상적으로 이미지가 출력되는것을 확인할 수 있습니다. 하지만 레티나 이미지(@2x)를 구별하여 이미지를 로드하게 하려면 좀 더 추가적인 작업이 필요합니다.

#import <UIKit/UIKit.h>

@interface UIImage (Bundle)

+ (UIImage*)imageNamed:(NSString *)imageName bundle:(NSBundle*)bundle;

@end
#import "UIImage+Bundle.h"

@implementation UIImage (Bundle)

+ (UIImage*)imageNamed:(NSString*)imageName bundle:(NSBundle*)bundle
{
    // Extract base name and extension
    NSString* imageBaseName = [imageName stringByDeletingPathExtension];
    NSString* imageExt = [imageName pathExtension];
    if (!imageExt.length) imageExt = @"png";
    
    NSString* imagePath = nil;
    
    // Try retina version if available
    BOOL isRetina = ([[UIScreen mainScreen] scale] == 2.0);
    if (isRetina)
    {
        NSString* retinaImageBaseName = [NSString stringWithFormat:@"%@@2x", imageBaseName];
        imagePath = [bundle pathForResource:retinaImageBaseName ofType:imageExt];
    }
    
    // If not a Retina screen or retina image not found, try regular image
    if (!imagePath)
    {
        imagePath = [bundle pathForResource:imageBaseName ofType:imageExt];
        isRetina = NO;
    }
    
    // Build the image
    UIImage* image = [UIImage imageWithContentsOfFile:imagePath];
    // If retina version, set the scale appropriately
    if (isRetina)
    {
        image = [UIImage imageWithCGImage:image.CGImage scale:2.0 orientation:UIImageOrientationUp];
    }
    
    return image;
}

@end

이런식으로 카테고리를 만들어 사용하면 용이할 것 같습니다. [출처]