Skip to main content

Which is the best way to distribute Custom Framework?

So You have a solution to a problem that many other iOS developers have and you want to help them, but you also want to protect your code and build a business? Binary Framework. That's what you want!

You might have noticed that you can't see the source code of UIKit Framework you use to build your iOS apps on top of every day. That's because Apple ships the UIKit as a binary framework in its iOS SDK.

Below are the available ways of creating Libraries or framework:- 

Umbrella Framework: 

In the Apple development environment, the incorporation of one framework into another is called “Umbrella”. This type of framework is meant to hide the use of some sub-frameworks and thus facilitate their use. 

Umbrella frameworks available for macOS apps, but Apple does not recommend using them. Apple does not officially support the Umbrella Frameworks for iOS,watchOS, or tvOS, indeed citing the official documentation:

Don't create Umbrella Frameworks.

While it is possible to create umbrella frameworks using Xcode, doing so is unnecessary for most developers and is not recommended. Apple uses umbrella frameworks to mask some of the interdependencies between libraries in the operating system. In nearly all cases, you should be able to include your code in a single, standard framework bundle. Alternatively, if your code was sufficiently modular, you could create multiple frameworks, but in that case, the dependencies between modules would be minimal or nonexistent and should not warrant the creation of an umbrella for them.

https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPFrameworks/Concepts/CreationGuidelines.html “Apple Documentation”

Universal Framework (fat framework): 

multi-architecture binary that contains code native to multiple instructions sets and can run on multiple architectures. In short, it contains code compiled for all the platforms which you're going to support. For example x86_64 (64-bit simulator), arm64, armv7, armv7s for devices. As a result, such a framework will have a larger size than a one-architecture framework. There are lots of tutorials on how to make a universal framework using lipo. This approach widely used for sharing a private binary. In this way, your framework consumer able to work with your framework on a real device and simulator.

The loading of system frameworks is highly optimized. But loading custom embedded frameworks can be expansive. Apple's engineers encourage you to use frameworks wisely and limit the number of used frameworks because it impacts the app launch time. If you are interested in deep details on how the framework works and how it impacts the app launch time, check the WWDC session Optimizing App Startup Time

This year Apple declare that Swift 5 provides binary compatibility for apps, which means that an app built with one version of the Swift compiler will be able to talk to a library built with another version. Swift’s ABI is currently declared stable for Swift 5 on Apple platforms.


XCFrameworks:

XCframeworks is a new supported way to distribute binary frameworks, available from Xcode 11. Actually, a framework that can continuing binary for multiple architectures and platforms. Just generate archives for different platforms and bundle them up together in a single XCFramework.If you want to deep dive there is a great session Binary Frameworks in Swift from WWDC 2019. 

There are a few advantages of using XCFrameworks:

  • XCFramework contains variants not only for device and simulator but for any of the platforms that Xcode supports: iOS, macOS, tvOS, watchOS.
  • It Supports Swift and C-based code.
  • Can bundle up frameworks and static libraries.

Swift Package:

Swift is a cross-platform language and requires a cross-platform tool for building the Swift code. One of the goals of Swift Package Manager(SwiftPM) is to simplify distribution source code in the Swift ecosystem. SwiftPM is an open-source project, you can find information about it on Github as well.

Swift Package contains source files and manifest files (Package.swift). Manifest describes the configuration for the Swift package. The swift package is defined and used with Swift Package Manager, which included Swift 3.0 and above. Because of distribution in source form, there is no need to maintain binary compatibility for clients. So if you can ship the source code, then Swift Package is a great tool for you.

With the new package manifest API in XCode 12, it is now possible to make Swift Packages that include one or more XCFrameworks. The details of implementation you can find in the official documentation. Distributing Binary Frameworks as Swift Packages and WWDC 2020 Videos.

Swift Package consists of 3 parts: dependencies, targets, and products.

Dependencies: other Swift Packages, that you are using inside your package. In the Package file each dependency specified by source location and version.

Target: As Apple's document says, Targets are the basic building blocks of a Package. It may be either a library or an executable as its product. Before XCode 12 Swift Package could contain only Swift, Objective C/C++, or C/C++ files. XCode 12  offers the new tool-version:5.3 which brings the new package manifest API. And now the Swift Package can contain other resource types: images, storyboards, JSON files, Shell scripts, and much more. You can also localize those resources. that is a great and desired improvement. Thank you to all who have contributed to making this available. Useful details and implementation details, you can find the WWDC 2020 videos, Swift Packages: Resources and localization, and in documentation Localizing Package Resources.

Products: The output of your package, either a library and an executable produced by a package, and make them visible to other packages.

Summary:

You can see that nothing magical happens here, I described way of creating Libraries to disctibute your solution to developer community, you just need to select best option to distribute your solution, I hope it will help you.

Labels

Labels:

Comments

Post a Comment

Popular posts from this blog

Static Library, Dynamic Library, Framework Which is best way to distribute Custom Code?

If you’ve been developing for iOS for some time, you probably have a decent set of your own classes and utility functions that you reuse in most of your projects and shared with teams.  Well, there are different ways, the easiest way to reuse code is simply to copy/paste the source files. However,  this can quickly become a maintenance nightmare. Whenever you update the source code, you have to update the changes to all the files between teams and projects, Since each app gets its own copy of the shared code, it’s difficult to keep all the copies in synch for bug-fixes and updates. Also, this will not work if you don't want to expose the implementation details. When developing iOS apps you rarely implement everything from the ground-up, because operating systems, as well as the open-source community, offer a large amount of functionality ready-to-use. Such pieces of functionality are usually packed in a distributable form known as the library. In this article let's explore sta...
Post a Comment
Read more

What is the defer statement and what is the use of defer statement?

Defer Statement: Introduced in Swift 2.0, The Swift Defer statement isn't something you'll need to use often.  What is Defer? A defer statement is used for executing code just before transferring program control outside of the scope that the defer statement appears in. In simple words, defer is an operator used with closure where you include a piece of code that is supposed to be executed at the very end of the current scope. Syntax defer { statements } Example func f () { defer { print ( "defer statement executed" ) } print ( "End of function" ) } f () // Prints "End of function" // Prints "defer statement executed" The above example defer statement was executed after the print statement after the end of function f() 's Scope. Multiple Defer One of the most powerful features of defer statement is that you can stack up multiple deferred pieces of work, and Swift will ensure they all get executed. If you use multiple de...
Post a Comment
Read more