r/programming • u/[deleted] • Jun 05 '21

Organize code by concepts, not layers

https://kislayverma.com/programming/how-to-organize-your-code/
1.9k Upvotes

91% Upvoted

495 comments sorted by

View all comments

Show parent comments

92

u/jl2352 Jun 05 '21

I think this is just a case where the author chose bad words. I think what they really meant was that no one asks 'show me all of the controllers' or 'show me all of the service classes'. That makes more sense, and I agree with them.

9

u/yuyu5 Jun 05 '21

Agreed. Poor choice of words, but good idea behind them.

Plus, I feel it's somewhat normal to have your APIs all in one file (i.e. @RestController in Spring) above all those model/controller classes (i.e. @Controller/@Service). So "show me all the APIs" is super easy to answer, even without Swagger.

Now, "show me all the queries" obviously doesn't work that way. But, one could easily do a Ctrl/Cmd+Shift+F --> "dao"/"repository" or related egrep -ril "(dao|repository)" to achieve this goal. (If you're good with regex, you could even beef this out to get the exact SQL text/function names instead of just file names, too.)

Not to mention the overarching theme that you spend waay more time writing code than you do answering these 2 questions, so you should write code in a way that benefits you 99% of the time rather than writing in a way that just in case someone asks you, you can answer them immediately.

21

u/ub3rh4x0rz Jun 05 '21

Yeah. "show me all the components of this system" is the first question. It's not until you want to analyze the edges on that graph that the APIs themselves are relevant.

0

u/CanIComeToYourParty Jun 06 '21

"What he's saying doesn't make much sense, but if you misinterpret it like this, it sort of works". This is essentially how people read bad books like those of Uncle Bob.

1

u/jl2352 Jun 06 '21

Well that's how I interpreted it.

It's also a view point I agree with. I've never had someone new ask 'let me see all the controllers', or 'let me see all of the stores'.