TMCache 开源项目教程

TMCache 开源项目教程

TMCacheFast parallel object cache for iOS and OS X.项目地址:https://gitcode.com/gh_mirrors/tm/TMCache

1. 项目的目录结构及介绍

TMCache 项目的目录结构如下：

TMCache/
├── TMCache
│   ├── TMCache.h
│   ├── TMDiskCache.h
│   ├── TMDiskCache.m
│   ├── TMMemoryCache.h
│   ├── TMMemoryCache.m
│   └── ...
├── docs
│   └── ...
├── tests
│   └── ...
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.txt
├── README.md
├── TMCache.podspec
├── build_docs.sh
└── build_tests.sh

目录结构介绍

• TMCache: 包含 TMCache 项目的主要源代码文件，包括头文件和实现文件。
  • TMCache.h: TMCache 的主头文件。
  • TMDiskCache.h 和 TMDiskCache.m: 磁盘缓存的接口和实现。
  • TMMemoryCache.h 和 TMMemoryCache.m: 内存缓存的接口和实现。
• docs: 包含项目的文档文件。
• tests: 包含项目的测试文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目变更日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.txt: 项目许可证。
• README.md: 项目说明文档。
• TMCache.podspec: CocoaPods 配置文件。
• build_docs.sh: 构建文档的脚本。
• build_tests.sh: 构建测试的脚本。

2. 项目的启动文件介绍

TMCache 项目的启动文件是 TMCache.h，它包含了 TMCache 的主要接口和定义。

#import <Foundation/Foundation.h>
#import "TMDiskCache.h"
#import "TMMemoryCache.h"

@class TMCache;
typedef void (^TMCacheBlock)(TMCache *cache);
typedef void (^TMCacheObjectBlock)(TMCache *cache, NSString *key, id object);

@interface TMCache : NSObject

@property (strong, nonatomic, readonly) TMMemoryCache *memoryCache;
@property (strong, nonatomic, readonly) TMDiskCache *diskCache;

+ (instancetype)sharedCache;

- (instancetype)initWithName:(NSString *)name;
- (instancetype)initWithName:(NSString *)name rootPath:(NSString *)rootPath;

- (id)objectForKey:(NSString *)key;
- (void)objectForKey:(NSString *)key block:(TMCacheObjectBlock)block;

- (void)setObject:(id <NSCoding>)object forKey:(NSString *)key;
- (void)setObject:(id <NSCoding>)object forKey:(NSString *)key block:(TMCacheObjectBlock)block;

- (void)removeObjectForKey:(NSString *)key;
- (void)removeObjectForKey:(NSString *)key block:(TMCacheObjectBlock)block;

- (void)removeAllObjects;
- (void)removeAllObjects:(TMCacheBlock)block;

@end

启动文件介绍

• TMCache.h: 定义了 TMCache 的主要接口，包括内存缓存和磁盘缓存的属性，以及对象的存取方法。
• TMMemoryCache.h 和 TMDiskCache.h: 分别定义了内存缓存和磁盘缓存的接口。

3. 项目的配置文件介绍

TMCache 项目的配置文件主要包括 .gitignore, .travis.yml, TMCache.podspec 等。

.gitignore

.gitignore 文件用于指定 Git 版本控制系统忽略的文件和目录。

# Xcode
build/
*.pbxuser
!default.pbxuser
*.mode1v3
!default.mode1v3
*.mode2v3
!default.mode2v3
*.perspectivev3
!default.perspectivev3
xcuserdata
*.xccheckout
*.moved-aside
DerivedData
*.hmap
*.ipa
*.xcuserstate

# CocoaPods

TMCacheFast parallel object cache for iOS and OS X.项目地址:https://gitcode.com/gh_mirrors/tm/TMCache