서버 국룰

😍백엔드 개발시 알아두면 좋은점!!!

 

■ dev/prod/localhost

개발 단계

local에서 개발 후 dev에 완성된 API를 배포

모든 API를 완성한 후 dev에서 테스트 완료가 되었다면 prod 서버에 배포

 

localhost

• API를 개발할 떄 우선 로컬에서 개발합니다

dev

• 완성된 API를 배포하고 전체적인 테스트나 유닛 테스트를 진행하는 서버 클라이언트와의 연동은 우선 dev 서버에서 진행

prod

• 클라이언트도 완성된 후 유저들이 사용하는 서버

 

dev, prod 관리

서브 도메인을 통해 관리, https는 당연히 해야겠죠?

ex) dev 서버 → dev.servername.shop

prod 서버 → prod.servername.shop

 

RDS 분리

API 개발에서 dev와 prod를 분리하듯이 데이터베이스도 역시 분리가 필요하다

 

dev RDS

• dev 서버, localhost에서 사용할 데이터베이스
• 서버 개발자만 사용하는 데이터베이스라 생각하면 편함
• 더미 데이터로 데이터 insert해서 테스트

prod RDS

• prod 서버에서 사용할 데이터베이스
• 배포용 데이터베이스이기 때문에 더미 데이터는 사용하지 않는다
• 실제 데이터들을 insert해서 사용

 

■ database

테이블명과 컬럼명 표기의 통일성

여러명이 협업을 하다보면 각각의 표기법 스타일이 다 다를 수 밖에 없음

꼭 개발에 들어가기 전 테이블명과 컬럼명의 표기법들을 정리해야함

 

표기법 종류

1. 파스칼 케이스ex) UniversityMakeusChallenge
2. 대문자로 시작하고 각 단어의 첫문자를 대문자로 표기함

 

1. 카멜 케이스ex) universityMakeusChallenge
2. 소문자로 시작하고 각 단어의 첫문자를 대문자로 표기함

 

1. 스네이크 케이스ex) university_makeus_challenge
2. 파이썬에서 자주 사용되는 표기법, 자바스크립트나 자바에서는 잘 사용하지 않음
3. 소문자로 시작하고 각 단어의 구분을 언더바(_)로 표기함

 

 

 

테이블 주석과 컬럼 주석의 필요성

코드의 이해를 돕기 위해 주석을 달듯이 erd의 이해를 위해서도 주석이 반드시 필요

주석에는 각 컬럼에 대한 설명이나 들어가는 데이터의 종류와 의미를 표기

ex) User 테이블에서 status 컬럼에 대한 주석

유저 데이터 상태 ACTIVE: 활성화 INACTIVE: 비활성화 DELETED: 삭제됨

자주 사용되는 변수명의 경우 개발자들과 합의 후에 사용

ex) 데이터 값들의 상태를 나타내는 컬럼의 경우 status라 표기하는 사람도 있고 state라 표기하는 사람이 있을 수 있음

통일을 하지 않게 되면 쿼리나 response를 return할 때 불편함이 생길 수 있기 때문에 변수명에 대한 합의 후에 사용하도록 하자