Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Why to avoid forced unwrapping

Tags:

swift

optional

There are cases where you forgot to set a value (so it's actually a bug), and running the program with forced unwrapping can crash the problem, and that can allow you to track down the bug where you forgot to set the value that you should have set.

From posts talking about avoiding forced unwrapping, it's always brought up that forced unwrapping can crash the program therefore it's a bad thing. What's so bad about crashing a problem when it actually has a bug?

Please give examples where forced unwrapping can be bad.

(I'm not saying forced unwrapping is suitable for everything.)

like image 763
Andy Avatar asked Oct 12 '17 17:10

Andy


People also ask

How does Swift handle force unwrap?

Even though Swift isn't sure the conversion will work, you can see the code is safe so you can force unwrap the result by writing ! after Int(str) , like this: let num = Int(str)! Swift will immediately unwrap the optional and make num a regular Int rather than an Int? .

Should you force unwrap Swift?

Heck, even if you're 99.999% certain that it's safe, you shouldn't be using it – that equates to one crash in 100,000, which is really bad. Instead, force unwraps should be reserved for times when your code is absolutely guaranteed to be safe, as demonstrated above.

What will happen if you try to unwrap an optional that contains nil like so?

Unwrap an optional type with the nil coalescing operator If a nil value is found when an optional value is unwrapped, an additional default value is supplied which will be used instead. You can also write default values in terms of objects.


1 Answers

Forced unwrapping (and I'm going to include force-casting as well) should only be used when you, as the programmer, know for a fact that an optional will never actually ever be nil unless that nil represents a clear bug in your code during development (and then you want it to crash).

There are many examples where this type of forced unwrapping is appropriate. Examples include:

  • Getting the path to a known file in your app bundle (nil means you forgot to target the file during development).
  • Force casting a call to UITableView dequeueReusableCell (nil means you have a mistake in your storyboard).
  • Getting a specific component from DateComponents when you just specially asked Calendar for that component (nil mean you have a typo).

There are obviously many other cases where forced-unwrapping is appropriate but you must have a clear understanding of those cases.

But there are just as many runtime decisions that result in optionals that you can't guarantee and such cases should not be forced unwrapped.

Examples include:

  • Dealing with any user input. Never assume a user enters valid data. Never assume a value can be converted as expected. Always check for nil results.
  • Parsing JSON results. Never assume the data you get matches some expected format even if that format is clearly documented and always seems to work. Things change over time. Gracefully handle such unexpected data instead of just assuming a value will always be there and of the assumed data type.
  • Dealing with any API that can throw or return optional results. Things can go wrong. Errors happen. Never assume you will get back a valid answer. Code defensively.

In the end, a developer with the proper experience and understanding of how optionals work, what they mean, and when a value may or may not ever actually be nil is in a position to safely use forced unwrapping when appropriate. Use it wisely.

Never use forced-unwrapping just because Xcode suggested it to make the compiler happy.

like image 198
rmaddy Avatar answered Sep 30 '22 17:09

rmaddy