Search
Duplicate

Code Convention

โ€ข
Entity
โ—ฆ
@Setter ์‚ฌ์šฉ ๊ธˆ์ง€
โ—ฆ
์ƒ์„ฑ์ž๋Œ€์‹  @Builder์“ฐ๊ธฐ
โ—ฆ
table๋ช…์€ TB_๋„๋ฉ”์ธ๋ช…
โ€ข
Dto
โ—ฆ
1api ๋‹น 1 dto(๋ฉ”์„œ๋“œ ๋ณ„๋กœ ๊ตฌ๋ถ„)
โ—ฆ
request, response ๋กœ ํŒจํ‚ค์ง€ ๋‚˜๋ˆ„๊ธฐ
โ—ฆ
ํด๋ž˜์Šค๋ช…์€ Req,Res๋กœ ๊ตฌ๋ถ„
โ—ฆ
record ์‚ฌ์šฉํ•ด๋ณด๊ธฐ
โ€ข
Service
โ—ฆ
Servcie๋ฅผ ์ฃผ์ž…๋ฐ›์•„์„œ ์‚ฌ์šฉํ•˜์ง€์•Š๊ณ  Repository ์ฃผ์ž…๋ฐ›์•„์„œ ์‚ฌ์šฉ
โ—ฆ
ServiceImpl? - ์‚ฌ์šฉ์ด์œ ๊ฐ€ ์•„์ง ์™€๋‹ฟ์ง€๊ฐ€ ์•Š์•„์„œ ๋ณด๋ฅ˜
โ—ฆ
class์— @Transactional์„ ๊ฑธ๊ณ  get์„ ํ• ๋•Œ๋Š” @Transactional(readOnly = true)์‚ฌ์šฉ
โ€ข
global
โ—ฆ
GoogleStyle์ ์šฉ
โ—ฆ
.ymlํŒŒ์ผ ์“ฐ๊ธฐ + ํ™˜๊ฒฝ๋ณ€์ˆ˜์ ์šฉํ•˜๊ธฐ
โ€ข
๋„ค์ด๋ฐ ๋ช…๋ช…๋ฒ•
โ—ฆ
์ฃผ์š” ๊ณตํ†ตํ•จ์ˆ˜ (CRUD๊ด€๋ จ)ํ•จ์ˆ˜๋ช…์€ ๊ธฐ๋Šฅ + ๋„๋ฉ”์ธ + (List)
โ–ช
๊ธฐ๋Šฅ (Create Update Delete Get) + ๋„๋ฉ”์ธ(Product,User, etcโ€ฆ) + (์—ฌ๋Ÿฌ๊ฐœ์กฐํšŒ๋ฉด List) + (๋’ค์— ๋‚ด์šฉ์ด ๋” ๋ถ™๋Š”๊ฑด ์ž์œ )
โ—ฆ
๋ณ€์ˆ˜๋‚˜ ๋ฉ”์„œ๋“œ๋Š” CamelCase๋กœ
โ—ฆ
ํด๋ž˜์Šค๋ช…์€ PascalCase๋กœ
โ—ฆ
repository ์—์„œ findById()ํ•˜๋Š” ๋ฉ”์„œ๋“œ๋Š” find + Domain์ด๋ฆ„ ํ˜•ํƒœ๋กœ ๋ช…๋ช…ํ•ด์ค€๋‹ค.
โ–ช
์˜ˆ) findUser(userId) , findProduct(productId)
โ€ข
exception
โ—ฆ
์—๋Ÿฌ์ฝ”๋“œ๋Š” ๊ฐ ๋„๋ฉ”์ธ์—์„œ ๊ด€๋ฆฌ (global์—์„œ errorcode๋Š” ์ธํ„ฐํŽ˜์ด์Šค๋กœ ์„ ์–ธ)
โ—ฆ
์—๋Ÿฌ์ฝ”๋“œ ํด๋ž˜์Šค ์ด๋ฆ„์€ ๋„๋ฉ”์ธ + ErrorCode
โ—ฆ
RuntimeException ์ƒ์†๋ฐ›๋Š” GlobalException์„ ์–ธ ํ›„ ๊ฐ ๋„๋ฉ”์ธ์—์„œ GlobalException ์ƒ์†๋ฐ›๋Š” ์˜ˆ์™ธ ๋”ฐ๋กœ ๋งŒ๋“ค์–ด์ฃผ๊ธฐ(์—๋Ÿฌ์ฝ”๋“œ์— ๋งž๋Š” ๋ฉ”์„œ๋“œ๋ช…์œผ๋กœ ์„ค์ •)
โ€ข
๋””๋ ‰ํ† ๋ฆฌ๊ตฌ์กฐ
โ—ฆ
domain
โ–ช
admin (/api/v1/admin)
โ€ข
controller
โ€ข
service
โ–ช
user
โ€ข
controller
โ€ข
service
โ€ข
repository
โ€ข
entity
โ€ข
dto
โ€ข
exception
โ–ช
product
โ–ช
๋“ฑ๋“ฑ..
โ—ฆ
global