Objective-CのNullableの使い方5選

Objective-CのNullable属性の概要と具体的な使い方を学ぶObjctive-C
2023.11.14
この記事は約26分で読めます。

※本記事のコンテンツは、利用目的を問わずご活用いただけます。実務経験10000時間以上のエンジニアが監修しており、基礎知識があれば初心者にも理解していただけるように、常に解説内容のわかりやすさや記事の品質に注力しております。不具合・分かりにくい説明や不適切な表現、動かないコードなど気になることがございましたら、記事の品質向上の為にお問い合わせフォームにてご共有いただけますと幸いです。(理解できない部分などの個別相談も無償で承っております)
(送信された情報は、プライバシーポリシーのもと、厳正に取扱い、処分させていただきます。)

はじめに

プログラミング言語Objective-Cにおいて、コードの安全性と可読性を高めるためには、Null許容性を適切に管理することが重要です。

この記事では、Objective-CのNullable属性の使い方について5つの方法を初心者でも理解しやすいように解説します。

Nullable属性を使用することで、変数やメソッドの引数がNull値をとる可能性があることを明示的に表すことができ、エラーを減らしながらより堅牢なコードを書くことが可能になります。

ここではまず、Objective-CとNullについての基本的な説明から始め、その後にNullable属性の具体的な使用法に進んでいきます。

●Objective-Cとは

Objective-Cは、C言語にオブジェクト指向の機能を追加したプログラミング言語で、主にAppleのOS XやiOSの開発に用いられてきました。

そのシンタックスはC言語をベースにSmalltalkのメッセージング機能を取り入れたもので、動的な型付けやメッセージパッシングといった機能を持っています。

Objective-Cでは、プログラム中でデータの不確実性を扱うことが多く、そのためにNull許容性の概念が重要になってきます。

○Objective-Cの歴史と特徴

Objective-Cは、1980年代にBrad CoxとTom Loveによって開発されました。

AppleがNext Computerを買収した後、Objective-CはNeXTSTEPオペレーティングシステムの開発言語として採用され、その後Mac OS XやiOSの標準言語となりました。

Objective-CはC言語との高い互換性を保ちつつ、Smalltalkのオブジェクト指向の哲学を組み合わせることで、開発者が直感的で読みやすいコードを書くことを可能にしています。

○Objective-CでのNullとは

Objective-CでのNullは、何も指さないポインタ、すなわちオブジェクトの参照が存在しない状態を表します。

このNullを適切に扱うことは、プログラムのバグを防ぎ、安全なアプリケーションを作成する上で極めて重要です。

Objective-Cにおいては、特にポインタ型の変数に対してNullが許されるかどうかを明示することが、コードの理解とメンテナンスを容易にするための鍵となります。

●Nullable属性とは

Objective-CのNullable属性は、プログラマーが変数やメソッドの戻り値がnull（またはnil）値を取り得るかどうかを明示できるようにするためのものです。

Nullable属性を使用することで、コードの意図がより明確になり、コンパイラがより正確な警告やエラーを提供するのを助けます。

これは特にAPIデザインや大規模なプロジェクトでの協業時に重要となります。

○NullableとNullabilityの重要性

Nullabilityの概念はプログラミングの基本ですが、Objective-Cでは特に注意を払う必要があります。

というのも、Objective-Cはnilメッセージの概念を持っており、これは他の言語でのnull参照例外の原因になる操作を許容するからです。

Nullableという注釈を付けることで、オプショナルな値を扱っていることを明確にし、開発者はその変数を安全に使用できます。

○Nullable属性の基本的な構文

Nullable属性を使うには、変数宣言の前に_Nullableキーワードを使用します。

また、プロパティやメソッドの宣言においても、同様に_Nullableをパラメータや戻り値の型の前に指定します。

これにより、その値がnullになる可能性があることをコンパイラと読み手の両方に伝えることができます。

例えば、次の構文は一般的なNullable属性の使用法を示しています。

// 変数にNullable属性を適用する例
NSString * _Nullable variableName;

// メソッドのパラメータにNullable属性を適用する例
- (void)methodName:(NSString * _Nullable)parameterName;

// プロパティにNullable属性を適用する例
@property (nonatomic, copy, nullable) NSString *propertyName;

このようにNullable属性を適切に使用することで、開発者はより堅牢で安全なコードを書くことができるようになります。

また、データの流れを追跡しやすくなるため、デバッグの効率も上がります。

●Nullableの使い方

Objective-CにおけるNullable属性の使い方には複数のアプローチが存在し、開発者がNull許容性をコードに導入する際には、これが重要な役割を果たします。

Nullableを適切に使うことで、参照がNull値を取り得ることを明示的に宣言でき、コードの安全性を高めると同時に、Nullとの互換性を保ちつつ、開発者の意図をコード上でより明確にすることができます。

Objective-Cでは、Nullの扱いはプログラムの安定性と直接的に関連しており、Nullable属性を利用することで、ポテンシャルなNull参照を回避することが可能となります。

ここでは、Nullable属性を使う5つの主な方法を紹介し、それぞれについて具体的な使い方をサンプルコードと共に解説します。

○サンプルコード1：Nullable変数の宣言

Objective-CでNullable変数を宣言する場合、通常の変数宣言の前にnullableキーワードを付けることで、その変数がNull値を取り得ることを表します。

ここでは、StringオブジェクトのNullable変数を宣言するサンプルコードを紹介します。

NSString * _Nullable nullableString = nil;

このコードでは_Nullableを使ってNSString型の変数nullableStringを宣言し、最初にnilで初期化しています。

この例では、変数nullableStringがNull値を許容することを示しており、プログラム内でnullableStringを安全にNullチェックすることができます。

○サンプルコード2：メソッドのパラメータでのNullableの使用

メソッドのパラメータをNullableとして宣言することで、呼び出し側にそのパラメータがNullである可能性があることを通知し、そのメソッド内でNullチェックを実施することができます。

下記のコードは、Nullableなパラメータを受け取るメソッドの宣言と実装の一例です。

- (void)processString:(NSString * _Nullable)inputString {
  if (inputString != nil) {
    // inputStringがNullでない場合の処理
    NSLog(@"inputString is not null: %@", inputString);
  } else {
    // inputStringがNullの場合の処理
    NSLog(@"inputString is null");
  }
}

このコードでは、メソッドprocessString:が_Nullableキーワードを用いてNullを許容するNSString型のパラメータinputStringを受け取っています。

この例では、inputStringパラメータがNullでない場合には通常の処理を行い、Nullである場合には適切なメッセージをログに出力しています。

上記のサンプルコードを実行した場合、パラメータとして渡された文字列がNullかどうかに応じて異なるログが出力されます。

たとえば、inputStringに実際の文字列が渡された場合、コンソールにはその文字列に関する情報が表示されますが、Nullが渡された場合には「inputString is null」というメッセージが表示されます。

これにより、メソッドの使用者は、メソッドの引数としてNullを安全に渡すことができ、Nullに対する安全な対応をメソッド内部で容易に実装できます。

○サンプルコード3：プロパティのNullable宣言

Objective-Cの開発では、Null許容性の指定が安全性と可読性の向上に役立ちます。

特に、クラスのプロパティがnilを許容するかどうかを宣言する場合、この指定は重要です。

Nullable属性を使うと、プロパティがNullを許容することを明示的に表せます。

ここではObjective-Cにおけるプロパティ宣言でのNullableの使い方を紹介します。

プロパティにNullableを宣言することで、そのプロパティがnull可能であることをコンパイラに伝えることができます。

これにより、Null許容の意図がコード全体で一貫していることを保証し、不意のnull参照エラーから保護します。

@interface MyClass : NSObject

@property (nonatomic, strong, nullable) NSString *nullableProperty;

@end

このコードでは@interface宣言を使って、MyClassという新しいクラスを定義しています。

ここでnullableというキーワードをNSString型のnullablePropertyプロパティの属性として加えることで、このプロパティがnull値を許容することを表しています。

nonatomicとstrongはこのプロパティの他の属性であり、それぞれマルチスレッド環境下での利用を安全にすると同時に、参照カウントに基づいたメモリ管理を指示しています。

コードの実行によって、MyClassのインスタンスを生成してプロパティにアクセスする際に、そのプロパティがnullを許容しているという点が、動的な状況でも管理されます。

例えば、次のようにMyClassのインスタンスを生成し、nullablePropertyプロパティにアクセスすることができます。

MyClass *myInstance = [[MyClass alloc] init];
myInstance.nullableProperty = @"This is a nullable string";
NSLog(@"%@", myInstance.nullableProperty); // 出力: This is a nullable string

myInstance.nullableProperty = nil;
NSLog(@"%@", myInstance.nullableProperty); // 出力: (null)

初めに、MyClassのインスタンスを作成し、nullablePropertyに文字列を割り当てています。

この時点ではnullablePropertyは非nullの状態です。

その後、このプロパティにnilを割り当てることで、プロパティがNullを許容していることを確認できます。

ログにはnullが出力されますが、これはnullablePropertyがnullを許容するため問題ありません。

○サンプルコード4：Nullableと非Nullの相互作用

Objective-Cでは、nullableキーワードを使用することで、変数やメソッドの引数がnullを許容するかどうかを明示できます。

nonnullキーワードと組み合わせて使用することで、コードの意図を明確にし、安全性を向上させることができます。

ここではnullableとnonnullの相互作用を示すサンプルコードを記述します。

このコードでは、特定の条件下でのnull許容性を持つ変数と非null変数の使用を表しています。

// Nullableと非Nullの変数を宣言します。
- (void)processUserWithName:(NSString * _nullable)name address:(NSString * _nonnull)address {
    // nameがnullかどうかをチェックします。
    if (name == nil) {
        NSLog(@"名前はnullです。");
    } else {
        NSLog(@"名前: %@", name);
    }
    // addressはnullではないと見なされます。
    NSLog(@"アドレス: %@", address);
}

// 上記メソッドの使用例
[self processUserWithName:nil address:@"123 Apple Seed Ave"];

この例では、processUserWithName:address:メソッドがnameとしてnullableタイプの文字列を、addressとしてnonnullタイプの文字列を受け取ることを表しています。

nameがnilであるかどうかを確認しており、addressは常に非nullの値が渡されると期待しています。

このコードを実行すると、nameがnilであるため、最初のNSLogで「名前はnullです。」と表示されます。次にaddressがnonnullであるため、正しい住所が出力されます。

実際にこのコードを実行すると、コンソールには次のように表示されます。

名前はnullです。
アドレス: 123 Apple Seed Ave

これにより、nullableとnonnullを適切に使用することで、関数やメソッドにおける引数の扱いを明確にすることができ、ランタイムエラーを回避する助けとなることがわかります。

○サンプルコード5：Nullableの型アノテーションを使ったAPIの設計

APIを設計する際にnullable型アノテーションを使うと、開発者がnullを許容するパラメータや戻り値を取り扱う方法を明確にできます。

これは特に、外部からのデータに依存する関数やメソッドにおいて重要です。

ここではAPI設計時にnullableアノテーションを活用するサンプルコードを紹介します。

// このAPIは外部から提供されるデータを取り扱います。
@interface APIClient : NSObject

// このメソッドはnull許容の戻り値を持ちます。
- (void)fetchUserDataWithCompletion:(void (^ _Nullable)(NSDictionary * _Nullable userData, NSError * _Nullable error))completionHandler;

@end

@implementation APIClient

// ユーザーデータのフェッチを行い、結果をcompletionHandlerを通して返します。
- (void)fetchUserDataWithCompletion:(void (^ _Nullable)(NSDictionary * _Nullable, NSError * _Nullable))completionHandler {
    // ネットワークリクエストやデータ処理を模擬します。
    // 完了時にcompletionHandlerを呼び出します。
    NSDictionary *userData = @{@"name": @"John Doe", @"age": @30};
    NSError *error = nil; // 通常はエラーハンドリングを行いますが、ここでは省略します。

    // ここでcompletionHandlerがnilでないかチェックします。
    if (completionHandler) {
        completionHandler(userData, error);
    }
}

@end

このコードでは、APIClientクラスのfetchUserDataWithCompletion:メソッドがユーザーデータを非同期に取得し、処理が完了したらcompletionHandlerを通じて結果を返すように設計されています。

completionHandler自体もnullableであるため、呼び出し元がコールバックを省略することも許容されます。

また、completionHandlerの引数もnullableですので、データの取得に成功した場合と失敗した場合の両方をサポートしています。

このAPIを利用するときのコードは次のようになります。

APIClient *client = [[APIClient alloc] init];
[client fetchUserDataWithCompletion:^(NSDictionary * _Nullable userData, NSError * _Nullable error) {
    if (userData) {
        NSLog(@"ユーザーデータ: %@", userData);
    } else if (error) {
        NSLog(@"エラー: %@", error);
    }
}];

ここでは、fetchUserDataWithCompletion:メソッドが成功時にユーザーデータをログに出力し、失敗時にエラーをログに出力します。

結果のnull許容性により、APIの使用者は成功または失敗のケースを柔軟に扱うことができます。

●Nullableの応用例

Objective-Cのプログラミングにおいて、Nullableの指定は変数やメソッドのパラメータ、プロパティがnull値を許容するかどうかを表します。

これはコードの安全性を高めるために重要な概念であり、Null許容性の適切な使用はアプリケーションのクラッシュを防ぐために不可欠です。

Nullableの応用は多岐にわたりますが、ここでは、いくつかの実用的な例を詳細に説明し、具体的なコード例を用いてその使い方を見ていきましょう。

○サンプルコード6：OptionalチェーンとNullableの組み合わせ

Objective-CではOptionalチェーンを利用して、Nullableオブジェクトのプロパティやメソッドにアクセスする際の安全性を高めることができます。

下記のコードは、Optionalチェーンを使用してNullableオブジェクトのプロパティに安全にアクセスする方法を表しています。

// MyClass.hファイル
@interface MyClass : NSObject

@property (nullable, nonatomic, strong) NSString *name;

@end

// MyClass.mファイル
@implementation MyClass

// このメソッドでは、self.nameがnullでなければ処理を続け、nullであれば処理を停止します
- (void)printName {
    if (self.name) {
        NSLog(@"Name is %@", self.name);
    } else {
        NSLog(@"Name is null");
    }
}

@end

// 使い方
MyClass *myObject = [[MyClass alloc] init];
myObject.name = nil; // nameにnullを設定
[myObject printName]; // Name is nullと出力されます

このコードでは、MyClassのインスタンスmyObjectのnameプロパティがnullかどうかをチェックしています。

printNameメソッドはnameがnullでない場合のみ名前を出力し、nullの場合は別のメッセージを出力します。

○サンプルコード7：エラーハンドリングとNullable

エラーハンドリングはプログラミングでよく見られるパターンであり、Nullableと組み合わせることでさらに効果的になります。

NSErrorオブジェクトを使ったエラーの報告は、特に成功したかどうかが明確でない場合に便利です。

// エラーハンドリング可能なメソッドを宣言
- (BOOL)doSomethingWithError:(NSError * _Nullable * _Nullable)error;

// エラーハンドリングを行うメソッドの実装
- (BOOL)doSomethingWithError:(NSError *__autoreleasing  _Nullable *)error {
    // ... 何かの処理 ...
    // エラーが発生した場合
    if (error) {
        *error = [NSError errorWithDomain:@"com.example.error" code:100 userInfo:nil];
        return NO;
    }
    // 処理が成功した場合
    return YES;
}

// エラーハンドリングを行うメソッドの使用例
NSError *error = nil;
if (![myObject doSomethingWithError:&error]) {
    NSLog(@"Error: %@", error);
} else {
    NSLog(@"Success");
}

この例では、doSomethingWithError:メソッドが成功するかどうかに基づいてBOOL値を返します。

エラーが発生すると、参照渡されたNSErrorポインタにエラー情報が格納され、メソッドはNOを返します。

呼び出し元はこの戻り値を検証して、エラーがあれば内容を確認します。

○サンプルコード8：Nullableのカスタムカテゴリの作成

Objective-Cではカテゴリを使って既存のクラスに新しいメソッドを追加することができます。

Nullable属性を持つメソッドをカテゴリを通じて追加することもでき、これによってクラスの機能を安全に拡張することが可能になります。

// NSStringのカテゴリを宣言
@interface NSString (MyCustomNullable)

- (nullable NSString *)stringByAppendingNullableString:(nullable NSString *)aString;

@end

// NSStringのカテゴリを実装
@implementation NSString (MyCustomNullable)

- (nullable NSString *)stringByAppendingNullableString:(nullable NSString *)aString {
    if (aString == nil) {
        return self;
    }
    return [self stringByAppendingString:aString];
}

@end

// カテゴリメソッドの使用例
NSString *hello = @"Hello, ";
NSString *world = @"World!";
NSString *greeting = [hello stringByAppendingNullableString:world];
NSLog(@"%@", greeting); // Hello, World!と出力されます

このコードはNSStringクラスにstringByAppendingNullableString:メソッドを追加しています。

このメソッドは、渡された文字列がnullであっても安全に処理を行い、nullでない場合は2つの文字列を結合して返します。

●Nullableの注意点と対処法

プログラミング言語Objective-CにおけるNullableの使用は、その便利さにも関わらず、いくつかの注意点があります。

Nullableを使用する際には、特にNull許容性を誤って解釈しやすい点に注意が必要です。

一方で正しく使用された場合、コードの安全性を高め、意図しないエラーから保護することができます。

一つ目の注意点は、Nullable変数を扱うことでNull参照エラーの可能性が生まれるということです。

変数がNullの可能性を持つということは、それを使っているすべてのコードで、Nullチェックを行う必要があるということです。

Nullを許容することで、メソッドや関数が予期せずNullを受け取った場合に備えたコードを書くことが重要になります。

二つ目の注意点は、Nullableの使用がAPIの設計に与える影響です。

例えば、あるメソッドがNullableなパラメータを受け取る場合、そのメソッドの使用者は、メソッドがNullを受け入れることを理解し、適切に対応する必要があります。

したがって、APIの文書化を行う際には、どのパラメータがNullableであるかを明記し、その取り扱い方を明確にすることが不可欠です。

三つ目の問題は、既存の非Nullコードとの互換性です。

古いコードがNullチェックをしていない場合、新しいNullableなコードの導入によってエラーが生じる可能性があります。

このような互換性の問題を解決するためには、既存のコードを慎重にレビューし、必要に応じて修正する作業が必要になります。

これらの注意点を踏まえ、下記に具体的な対処法をサンプルコードとともに説明します。

○コンパイラの警告との対処

Objective-Cのコンパイラは、Nullable属性を導入することで発生する潜在的な問題に対して警告を提供します。

しかし、これらの警告は時として大量に表示されることがあり、その全てに目を通すのは困難です。

コンパイラ警告に効果的に対処する方法の一つとして、警告を段階的に修正していくアプローチがあります。

サンプルコードを見てみましょう。

Objective-Cではnullableキーワードを使って、変数がNullを取り得ることを明示します。

下記のコードは、Nullable変数を宣言し、それを安全に使用する方法を表しています。

// Nullable変数の宣言
NSString * __nullable someString = nil;

// Nullable変数の安全な使用
if (someString != nil) {
    // someStringがnullでない場合のみこのブロックが実行される
    NSLog(@"someStringは: %@", someString);
} else {
    // someStringがnullの場合にここを実行
    NSLog(@"someStringはnullです");
}

このコードでは、__nullableアノテーションを使ってNSString型の変数someStringがNullを許容することを宣言しています。

この後のif文では、someStringがNullでないことを確認してからログに出力しており、これによりNull参照によるクラッシュを防いでいます。

このようにNullable変数を使用する際には、Nullチェックを適切に行うことで安全性を確保することができます。

○Nullableと古いObjective-Cコードの互換性

新しいコードにNullable属性を導入する際には、古いコードとの互換性を保つための検討が必要です。

古いコードベースでは、Nullが考慮されていない可能性があるため、Nullableを導入する前に、次のようなステップを踏むことをお勧めします。

  1. 古いコードのNullチェックの有無を確認し、必要であれば追加する。
  2. APIドキュメントを更新し、どのパラメータがNullableであるかを記載する。
  3. Nullableを導入したコードを徐々にデプロイし、テストを行う。

この段階的アプローチは、特に大規模なプロジェクトや、多くのユーザーによって使用されているライブラリにおいて効果的です。

Objective-CのNullableの取り扱い方を理解することは、強力で安全なプログラミングを実践する上で非常に重要です。

適切なNullチェックと文書化によって、コードの品質と保守性を高めることができるでしょう。

●カスタマイズ方法

Objective-Cにおけるカスタマイズ方法とは、特にNull許容性を指定する際に、ソフトウェア開発者が特定のAPIやコードブロックにおいて、より細かいNull関連の動作を設計することを指します。

このプロセスには、コードの堅牢性を高め、想定外のNull値によるクラッシュを防止するための様々な手法が含まれます。

Objective-Cでは、Null許容性を示すための構文が用意されており、これらを使いこなすことで、開発者はAPIの利用者に対して明確なガイドラインを提供できます。

また、既存のコードベースにNull許容性の注釈を追加することで、古いコードと新しいコードの互換性を保ちつつ、品質を向上させることが可能になります。

○Nullabilityのアノテーションをカスタマイズする方法

Objective-Cでは、Null許容性を指定するために「_Nullable」、「_Nonnull」、そして「_Null_unspecified」の三つのアノテーションが提供されています。

これらのアノテーションを効果的に使用することで、変数やパラメータ、プロパティのNull許容性をコントロールできます。

カスタマイズの一例として、既存の変数に対してNull許容性を後付けする方法を紹介します。

// 既存の変数にNullableアノテーションを追加する
NSString * _Nullable variableName = @"Example String";

このコードでは、NSString型の変数variableNameを宣言し、初期値として”Example String”を割り当てています。

アノテーション「_Nullable」を使用することで、この変数がNull値を取る可能性があることを明示しています。

これにより、変数の使用時にNullチェックを強化する必要があることが開発者に通知されます。

実行すると、variableNameはNullまたは有効なNSStringオブジェクトを参照することができるようになります。

これはAPIを設計する際に、ユーザが意図的にNull値を受け入れるか、あるいは誤ってNullを渡す可能性がある場合に特に有用です。

○プロジェクトの既存コードへのNullableの統合

プロジェクトの既存コードにNullableを統合する際には、次の手順を踏むことが推奨されます。

  1. まず、全てのヘッダファイルを対象にし、公開されているすべてのプロパティとメソッドのシグネチャにNull許容性アノテーションを適用します。
  2. Nullを許容する必要があるすべてのパラメータや戻り値には「_Nullable」アノテーションを追加します。
  3. Nullを許容してはならない場合には「_Nonnull」を使い、APIの利用者に対して非Nullの契約を強制します。
  4. コード内でNullチェックを行う必要がある箇所を特定し、適切なNullチェックロジックを実装します。
// メソッド宣言時にNullableを使う例
- (void)customMethodWithParameter:(NSString * _Nullable)parameter {
    // Nullチェックを実施
    if (parameter != nil) {
        // Nullでない場合の処理
        NSLog(@"Parameter is not null: %@", parameter);
    } else {
        // Nullの場合の処理
        NSLog(@"Parameter is null");
    }
}

この例ではcustomMethodWithParameter:メソッドを定義し、parameterがNullかどうかをチェックしています。

これにより、メソッドが安全に実行されるようにし、Null参照による問題を未然に防ぎます。

まとめ

Nullableの適用は、安全性とコードの品質を確保する上で不可欠です。

変数がNull値を許容するかどうかを明示することで、意図しないNullポインタ例外を避け、開発プロセス中に発生する可能性のある多くのエラーを事前に防ぐことができます。

特に、APIの設計や外部からのデータ処理においては、NullableとNonnullの間の明確な区分はプログラマにとって強力なツールとなります。

この記事では、Objective-CにおけるNullableの宣言方法から始め、メソッドパラメータやプロパティでの使用法、さらにはNullableと非Nullの変数やアノテーションの相互作用など、具体的なコード例を通じてその使用方法を解説しました。

また、Nullable属性を活用したエラーハンドリングのアプローチ、既存のコードへの統合方法、さらにはNullable属性をカスタマイズする様々なテクニックも紹介しました。

Objective-CにおいてNullableを効果的に使用することで、開発者はNullという潜在的な問題を制御下に置くことができ、可読性の高い、保守しやすいコードを書くことが可能になります。

この記事を通じて、Objective-CのNullable属性の基本から応用までの理解を深めることができたでしょう。

エラー処理の精度を上げ、コードの安全性を高めるために、Nullableを上手に使いこなしましょう。