oliverdavies.uk/source/_daily_emails/2024-09-05.md

36 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

---
title: find vs. get
date: 2024-09-05
permalink: daily/2024/09/05/find-vs-get
tags:
2024-09-08 22:09:54 +00:00
- software-development
- static-analysis
- podcast
cta: ~
snippet: |
2024-09-08 22:09:54 +00:00
find vs. get
drupal_planet: true
---
This week, I spoke with [Dave Liddament][2] to record an upcoming episode of [the Beyond Blocks podcast][1].
In that conversion, we started to talk about conventions, specifically unwritten conventions used within projects.
Dave mentioned on some of his projects, they have a convention for when to use `get` or `find` method prefix names.
For example, in a `UserRepository` class, a method like `findUserByEmail()` implies that a matching user may not be found.
Alternatively, `getUserByEmail()` implies that you're getting a user and will always be one found and returned.
This interested me and I [found a blog post by Thomas Uhrig][0] on find vs. get, which I've read since the recording.
In the context of the episode, we discussed how conventions like this can be codified and written down and checkable with static analysis tools, but it got me thinking about conventions I've consciously or unconsciously followed, as well as the impact of changing a small word in a method name on its behaviour.
What about you?
Do you have similar conventions that you follow in your applications?
[0]: https://tuhrig.de/find-vs-get
[1]: {{site.url}}/podcast
[2]: https://www.daveliddament.co.uk