{"id":40,"date":"2021-02-07T21:16:42","date_gmt":"2021-02-07T12:16:42","guid":{"rendered":"https:\/\/brevans.io\/?p=40"},"modified":"2021-02-11T20:52:54","modified_gmt":"2021-02-11T11:52:54","slug":"operation","status":"publish","type":"post","link":"https:\/\/brevans.io\/index.php\/2021\/02\/07\/operation\/","title":{"rendered":"Operation"},"content":{"rendered":"\n

How often do you see someone use DispatchQueue<\/code>? Now how often do you see Operation<\/code> and OperationQueue<\/code>? I feel like the Operation<\/code> class is severely underused in most apps. Granted, DispatchQueue<\/code> works fine, and Operation<\/code> is just a wrapper for Grand Central Dispatch, but that doesn’t mean much in the Swift world. After all, Swift is a High Level Language. If we use that same argument, we could be writing in C++ or Assembly directly. So let’s take a look at just what Operation<\/code> can do.<\/p>\n\n\n\n

For starters, DispatchQueue<\/code> doesn’t bode well for indentation. Once a few conditionals or loops appear the code starts looking more and more like a staircase:<\/p>\n\n\n\n

func doIt() {\n    DispatchQueue.global(qos: .background).async {\n        if thisCondition {\n            if thatCondition {\n                \/\/ Processing...\n            }\n        }\n    }\n}<\/code><\/pre>\n\n\n\n
Unless you’re an Escher fan, I can’t imagine that looks great. So let’s start converting that async<\/code> call into an Operation<\/code>. Starting simply, we can use the pre-made BlockOperation<\/code> All we need to do is call the initializer and pass in our code.<\/p>\n\n\n\n
func doIt() {\n    let operation = BlockOperation {\n        if thisCondition {\n            if thatCondition {\n                \/\/ Processing...\n            }\n        }\n    }\n}<\/code><\/pre>\n\n\n\n
So\u2026 the code looks about the same, maybe a little bit more verbose than anything. And to top it off, this operation doesn’t even execute yet. In fact, even if we added operation.start()<\/code> we wouldn’t be running asynchronously anyway. At this point, Operation<\/code> is looking like more work<\/em> than DispatchQueue<\/code>.<\/p>\n\n\n\n
So let’s start using Operation<\/code> the way it was meant to be, by moving the block into an Operation<\/code> subclass itself. This is fairly simple, override main()<\/code> and add a few checks for isCancelled<\/code>. Why check isCancelled<\/code>? Because an Operation<\/code> can be cancelled, unlike a DispatchQueue<\/code>. This is great for long running tasks that might not even end up needed by the time they are finished.<\/p>\n\n\n\n
class MyOperation: Operation {\n    override func main() {\n        guard !isCancelled else { return }\n\n        if thisCondition {\n            if thatCondition {\n                \/\/ Processing...\n            }\n        }\n    }\n}<\/code><\/pre>\n\n\n\n
Note that we want to check isCancelled<\/code> whenever we are going to take a bit of time to work. Loops are a great place to do this, and you might even think about using a good ‘ol for<\/code> rather than forEach<\/code> in those cases:<\/p>\n\n\n\n
for object in objectList {\n    guard !isCancelled else { return } \n    \/\/ Processing...\n}<\/code><\/pre>\n\n\n\n
Well, it’s been a bit of extra overhead, but let’s move back to the call site. Now we’re finally taken a step out of our staircase.<\/p>\n\n\n\n
func doIt() {\n    let operation = MyOperation()\n    if operation.isReady {\n        operation.start()\n    }\n}<\/code><\/pre>\n\n\n\n
In the above code, we need<\/em> to check if the operation\u2019s isReady<\/code>. Calling start<\/code> before the operation is ready (or while it is already running) is counterintuitive and will cause a crash.<\/p><\/blockquote>\n\n\n\n
That looks much better. Of course, some operations will need data passed in. Since it is a subclass, we can add nice initializers and properties for setting the data. In fact, adding custom initializers will also make it easier to write tests, so win-win on that.<\/p>\n\n\n\n
Once operation.start()<\/code> returns, the operation is already complete, and the data is ready to use. This is helpful for breaking up code into multiple classes, but running on the same thread as our current code is not what DispatchQueue.async<\/code> is doing (usually).<\/p>\n\n\n\n
Fortunately, that is exactly why OperationQueue<\/code>s exist. In the most basic implementation, we just need to instantiate the queue and add our operation. Remember to keep the queue around though.<\/p>\n\n\n\n
let operationQueue = OperationQueue()\n\nfunc doIt() {\n    let operation = MyOperation()\n    operationQueue.addOperation(operation)\n}<\/code><\/pre>\n\n\n\n
If we want to go even further, we can even set OperationQueue<\/code>\u2019s qualityOfService<\/code>. This performs a role similar to .global(qos: .background)<\/code> and completes the conversion from the DispatchQueue<\/code> example at the start of this article.<\/p>\n\n\n\n
let operationQueue: OperationQueue = {\n    let queue = OperationQueue()\n    queue.qualityOfService = .background\n    return queue\n}()\n\nfunc doIt() {\n    let operation = MyOperation()\n    operationQueue.addOperation(operation)\n}<\/code><\/pre>\n\n\n\n
At this point DispatchQueue<\/code> has been replaced and we have split out our code into a separate, testable class. But what about callbacks and updating our UI? Fortunately, Operation<\/code> has a completionBlock<\/code> property that is automatically called by the queue! While this will introduce a block again, this block only cares about cleanup and after actions, and may not even be needed.<\/p>\n\n\n\n
But wait there\u2019s more!<\/strong> What if we have multiple operations to complete? Where that would require calling DispatchQueue.aysnc<\/code> a couple of times, our OperationQueue<\/code> already takes care of that. Adding another operation with addOperation(_:)<\/code> is all that needs to be done. In fact, these operations can even be run concurrently or in order(!) by setting maxConcurrentOperationCount<\/code> on the queue.<\/p>\n\n\n\n
So I hope I’ve shown you some of the benefits of using Operations<\/code> over straight DispatchQueue<\/code> calls. We’re already using a high-level language, so how about we spend a little more time using high level constructs as well!<\/p>\n\n\n\n
\n\n\n\n
*If you have any questions, comments, or corrections let me know on Twitter<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
How often do you see someone use DispatchQueue? Now how often do you see Operation and OperationQueue? I feel like the Operation class is severely underused in most apps. Granted, DispatchQueue works fine, and Operation is just a wrapper for Grand Central Dispatch, but that doesn’t mean much in the Swift world. After all, Swift… Continue reading Operation<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-40","post","type-post","status-publish","format-standard","hentry","category-uncategorized","entry"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/brevans.io\/index.php\/wp-json\/wp\/v2\/posts\/40","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/brevans.io\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/brevans.io\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/brevans.io\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/brevans.io\/index.php\/wp-json\/wp\/v2\/comments?post=40"}],"version-history":[{"count":4,"href":"https:\/\/brevans.io\/index.php\/wp-json\/wp\/v2\/posts\/40\/revisions"}],"predecessor-version":[{"id":49,"href":"https:\/\/brevans.io\/index.php\/wp-json\/wp\/v2\/posts\/40\/revisions\/49"}],"wp:attachment":[{"href":"https:\/\/brevans.io\/index.php\/wp-json\/wp\/v2\/media?parent=40"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/brevans.io\/index.php\/wp-json\/wp\/v2\/categories?post=40"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/brevans.io\/index.php\/wp-json\/wp\/v2\/tags?post=40"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}