[bankApp04] μ½λ© 컨벀μ
π‘ μ½λ© 컨벀μ (coding convention)μ νΉμ νλ‘κ·Έλλ° μΈμ΄λ‘ μ½λλ₯Ό μμ±ν λ λ°λ₯΄λ μ€νμΌ κ°μ΄λ λλ κ·μΉ μΈνΈμ λλ€. μ΄λ λ³μλͺ , λ©μλλͺ , ν΄λμ€λͺ μ λ€μ΄λ° κ·μΉ, λ€μ¬μ°κΈ°, μ£Όμ μμ± λ°©λ², νμΌ κ΅¬μ‘°, μ½λ μ λ ¬ λ°©μ λ± νλ‘κ·Έλ¨μ κ°λ μ±, μ μ§λ³΄μμ±, μΌκ΄μ±μ ν₯μμν€κΈ° μν λ°©λ²λ‘ μ ν¬ν¨ν©λλ€.
μ½λ© 컨벀μ μ μ
- μ μ νμΌ (CSS, XML, JS)
- κ·μΉ: μλ¬Έμ μ¬μ©, λ¨μ΄ κ° κ΅¬λΆμ μ€λ€μ΄ν¬ μΌμ΄μ€(_)λ‘ ν©λλ€.
- μμ: style_sheet.css, config_file.xml, main_script.js
- JSP νμΌ
- κ·μΉ: μΉ΄λ© μΌμ΄μ€(CamelCase)λ₯Ό μ¬μ©νμ¬ μ²« κΈμλ μλ¬Έμλ‘ μμν©λλ€.
- μμ: home.jsp, accountPage.jsp
- μλ° νμΌ (ν΄λμ€)
- κ·μΉ: νμ€μΉΌ μΌμ΄μ€(PascalCase)λ₯Ό μ¬μ©νμ¬ κ° λ¨μ΄μ 첫 κΈμλ λλ¬Έμλ‘ μμν©λλ€.
- μμ: HomeController.java, AccountService.java
- HTML id, name μμ±
- κ·μΉ: μΉ΄λ© μΌμ΄μ€λ₯Ό μ¬μ©νμ¬ μ²« κΈμλ μλ¬Έμλ‘ μμν©λλ€.
- μμ: <input id="userName" name="userName"/>
- CSS ν΄λμ€
- κ·μΉ: μλ¬Έμ μ¬μ©, λ¨μ΄ κ° κ΅¬λΆμ νμ΄ν(-)(-)μΌλ‘ ν©λλ€. μΈλΆ λΌμ΄λΈλ¬λ¦¬μμ μΆ©λ λ°©μ§λ₯Ό μν΄ μ λμ¬λ₯Ό μ¬μ©νλ κ²μ κΆμ₯ν©λλ€.
- μμ: .btn--primary, .nav--item
- URL μ£Όμ μ€κ³
- κ·μΉ: λͺ¨λ μλ¬Έμ μ¬μ©, λ¨μ΄ κ° κ΅¬λΆμ νμ΄ν(-)μΌλ‘ ν©λλ€.
- μμ: /user-profile, /get-account-details
- λ°μ΄ν°λ² μ΄μ€ ν
μ΄λΈ
- κ·μΉ: μλ¬Έμ μ¬μ©, λ¨μ΄ κ° κ΅¬λΆμ μ€λ€μ΄ν¬ μΌμ΄μ€λ‘ ν©λλ€.
- μμ: user_account, transaction_history
- ν¨μλͺ
(μλΉμ€ λ μ΄μ΄)
- κ·μΉ: μΉ΄λ© μΌμ΄μ€λ₯Ό μ¬μ©νμ¬ μ²« κΈμλ μλ¬Έμλ‘ μμν©λλ€. ν¨μκ° μννλ λμκ³Ό κ°μ²΄λ₯Ό λͺ ννκ² ννν©λλ€.
- μμ: saveAccountDetails(Account account), findUserById(Long id)
π‘ μλΉμ€ λ μ΄μ΄
μλΉμ€ λ μ΄μ΄μμμ λ©μλ λ€μ΄λ°μ μ½λμ κ°λ μ±κ³Ό μ μ§λ³΄μμ±μ ν° μν₯μ λ―ΈμΉ©λλ€. λͺ ννκ³ μΌκ΄λ λ€μ΄λ° 컨벀μ μ μ¬μ©ν¨μΌλ‘μ¨, μ½λλ₯Ό λ μ½κ² μ΄ν΄νκ³ , λ€λ₯Έ κ°λ°μλ€μ΄ μ½λμ μνΈ μμ©ν λ λ°μν μ μλ νΌλμ μ΅μνν μ μμ΅λλ€. μλλ μλΉμ€ λ μ΄μ΄μμ λ리 μ¬μ©λλ λ€μ΄λ° 컨벀μ κ·μΉμ λλ€:
CRUD μ°μ°
Create: μλ‘μ΄ μν°ν°λ₯Ό μμ±νλ λ©μλλ createλ‘ μμν©λλ€.
μ: createUser(User user)
Read: μν°ν°λ₯Ό μ‘°ννλ λ©μλλ read, find, get λ±μΌλ‘ μμν μ μμ΅λλ€. λ¨μ μ‘°νλΏλ§ μλλΌ μ‘°κ±΄μ λ°λ₯Έ κ²μμ ν¬ν¨ν©λλ€.
μ: readUser(Long id), findUserByUsername(String username), getUserDetails(Long userId)
Update: μν°ν°λ₯Ό μμ νλ λ©μλλ updateλ‘ μμν©λλ€.
μ: updateUser(User user)
Delete: μν°ν°λ₯Ό μμ νλ λ©μλλ deleteλ‘ μμν©λλ€.
μ: deleteUser(Long id)
μ‘°ν μ°μ°
findBy: νΉμ 쑰건μ λ§μ‘±νλ μν°ν°λ₯Ό μ°Ύμ λ μ¬μ©ν©λλ€.
μ: findByUsername(String username)
findAllBy: μ£Όμ΄μ§ 쑰건μ λ§μ‘±νλ λͺ¨λ μν°ν°λ₯Ό μ°Ύμ λ μ¬μ©ν©λλ€.
μ: findAllByStatus(String status)
countBy: νΉμ 쑰건μ λ§μ‘±νλ μν°ν°μ μλ₯Ό κ³μ°ν λ μ¬μ©ν©λλ€.
μ: countByStatus(String status)
λͺ νν λλ©μΈ κ°μ²΄ μ²λ¦¬ νν λ©μλ μ΄λ¦μ μ²λ¦¬νλ νΉμ λλ©μΈ κ°μ²΄λ₯Ό λͺ ννκ² λνλ΄μΌ ν©λλ€.
μ΄λ λ©μλμ λͺ©μ μ΄λ μννλ μμ μ μ§κ΄μ μΌλ‘ μ΄ν΄ν μ μκ² ν΄ μ€λλ€.
μ: getOrderListByUserId(Long userId), updateUserProfilePicture(User user, Image picture)
ꡬκΈμ 컨벀μ μ΄ν΄λ³΄κΈ°
https://google.github.io/styleguide/
Google Style Guides
Style guides for Google-originated open-source projects
google.github.io