iOS框架优先读取主应用Bundle资源，失败再加载框架内资源的实现方案

Hey there, let's work through this bundle lookup problem for your iOS framework. The goal is clear: first check the main app's Bundle for your JSON files, fall back to the framework's Bundle if nothing's found. Let's break down why your initial approach didn't work and how to fix it.

Why bundleForClass:UIApplication.self Didn't Work #

When you call Bundle(for: UIApplication.self) from within your framework code, in some scenarios (like static framework setups or runtime class resolution quirks), the system might still return the framework's Bundle instead of the main app's. That's because the class lookup context can get tied to the framework's execution environment. Instead, we need a more reliable way to target the main app's Bundle.

Step-by-Step Implementation #

1. Prioritize the Main App Bundle #

Bundle.main is the most reliable way to access the main application's Bundle—it always points to the currently running app's resources, no matter where you call it from (framework or app code). We'll check here first for your JSON file.

2. Fall Back to the Framework's Bundle #

To get your framework's own Bundle, use Bundle(for: YourFrameworkClass.self) where YourFrameworkClass is any class that's part of your framework (e.g., a core manager class, or even self if you're writing this code inside a framework class). This ensures you're grabbing the framework's resource Bundle specifically.

Swift Code Example #

import Foundation

// Inside your framework class
func loadJSONFile(named fileName: String) -> Data? {
    // 1. Check main app Bundle first
    if let mainAppFileURL = Bundle.main.url(forResource: fileName, withExtension: "json"),
       let data = try? Data(contentsOf: mainAppFileURL) {
        print("Loaded JSON from main app Bundle: \(fileName)")
        return data
    }
    
    // 2. Fall back to framework Bundle
    let frameworkBundle = Bundle(for: type(of: self))
    // Alternatively, use a fixed framework class: Bundle(for: FrameworkCore.self)
    if let frameworkFileURL = frameworkBundle.url(forResource: fileName, withExtension: "json"),
       let data = try? Data(contentsOf: frameworkFileURL) {
        print("Loaded JSON from framework Bundle: \(fileName)")
        return data
    }
    
    // 3. Neither bundle has the file
    print("JSON file not found: \(fileName)")
    return nil
}

Objective-C Code Example #

#import <Foundation/Foundation.h>

@implementation YourFrameworkClass

- (NSData *)loadJSONFileWithName:(NSString *)fileName {
    // 1. Check main app Bundle first
    NSURL *mainAppFileURL = [[NSBundle mainBundle] URLForResource:fileName withExtension:@"json"];
    if (mainAppFileURL) {
        NSLog(@"Loaded JSON from main app Bundle: %@", fileName);
        return [NSData dataWithContentsOfURL:mainAppFileURL];
    }
    
    // 2. Fall back to framework Bundle
    NSBundle *frameworkBundle = [NSBundle bundleForClass:[self class]];
    // Alternatively, use a fixed framework class: [NSBundle bundleForClass:[FrameworkCore class]]
    NSURL *frameworkFileURL = [frameworkBundle URLForResource:fileName withExtension:@"json"];
    if (frameworkFileURL) {
        NSLog(@"Loaded JSON from framework Bundle: %@", fileName);
        return [NSData dataWithContentsOfURL:frameworkFileURL];
    }
    
    // 3. Neither bundle has the file
    NSLog(@"JSON file not found: %@", fileName);
    return nil;
}

@end

Key Notes to Avoid Issues #

• Case Sensitivity: iOS devices are case-sensitive when looking up file names, but simulators aren't. Make sure your JSON file names match exactly (e.g., Config.json vs config.json will be treated differently on a real device).
• Dynamic Framework Setup: If your framework is dynamic, ensure it's correctly embedded in the main app's target (check the "Frameworks, Libraries, and Embedded Content" section in your app's target settings).
• Directory-Specific Files: If your JSON files are inside subdirectories, add the subdirectory parameter to url(forResource:withExtension:subdirectory:) to target the right location.

Give this approach a shot—it should reliably prioritize the main app's JSON files before falling back to your framework's resources. If you hit any edge cases or have questions about specific setups, feel free to follow up!

内容的提问来源于stack exchange，提问作者Desmond DAI