Official-Dev. blog

📝 markdown-api-docs API 문서, API Reference, API docs를 작성하실 때 깃허브(Git hub)나 깃랩(Git lab)에 markdown으로 작성한 템플릿을 공유하고자 합니다. Source : https://github.com/violetbeach/markdown-api-docs 📚 API 설계 API Reference 자원 /resources 자원 등록 새로운 자원을 등록합니다. URL /resources Method: POST Data Paramsname=[String] - 자원명 count=[Integer] - 수량description=[String] - 자원 설명 Optional: Required: Responseid=[String] - 자원 일련번호 name=[..

O(log n), O(n log n) 사용을 왜하는 걸까? Google, Facebook의 경우 특정 테이블은 레코드가 몇십억, 몇백억 개가 있고, 테라 바이트, 페타 바이트 단위 이상이라고 합니다. 인덱스를 태우지 않고, 선형탐색으로 했을 때 레코드가 500만개만 있어도 요청 하나를 200초 안에도 처리하지 못합니다. O(n) 알고리즘을 사용했을 때 1000만번 계산해야 할 때, O(log n) 알고리즘을 사용할 때 수십 번만 계산해도 처리가 가능합니다. 그 차이는 데이터가 커질수록 기하급수적으로 커지겠죠. 그래서 대규모 서비스를, 아니 중규모 이상 서비스를 고려한다면 O(n) 알고리즘을 O(log n) 알고리즘을 사용하는 것이 중요합니다. 이런 이유로, Basic하게 배운 선형 탐색들을 사용하기 보다..

모델 매퍼(ModelMapper) 스프링의 경우 DTO와 엔터티간의 변환을 할 때 ModelMapper나 Mapstruct라는 라이브러리를 많이 사용합니다. 그러면, 객체가 가질 수 있는 프로퍼티는 옮겨지게 되고, 아닌 프로퍼티는 버려지게 되죠. JS는 그러한 역할이 없어서 상당히 불편했습니다. Interface를 고집한다는 점과 Class instance와 Literal object 간 변환이 어렵다는 점이 이유입니다. 그나마 쓸만한 라이브러리가 AutoMapper인데 사용하기가 어렵고 유지보수가 중지되었죠. 그래서 최근에 나와서 핫한 라이브러리 중 하나가 class-transformer입니다. 이 라이브러리는 ModelMapper 역할을 훌륭하게 수행할 수 있고, 상당히 강력하고 간단합니다. 최근 c..

스케일 업(scale-up), 스케일 아웃(scale-out) ? 대량의 서비스를 서버 1대로 처리할 수는 없게 됩니다. 더 많은 트래픽을 처리하기 위해서 스케일 업(서버의 성능을 업그레이드하는 것)과 스케일 아웃(서버의 대수를 늘려서 연결하는 것)이 있는데, 일반적으로는 스케일 아웃을 하게 됩니다. 왜냐하면 하드웨어 성능과 가격이 비례하지 않기 때문이죠. 대량생산되는 부품이 훨씬 싸기 때문이죠. 하지만, 스케일 아웃도 단점이 있습니다. 서버의 대수를 늘릴수록 관리가 힘들어지죠. 로드 밸런서로 연결해야 하기 때문에 엔드 포인트가 더 생기고 작업이 복잡해지는 것이죠. DB 동기화도 해야하구요. 동시성 제어도 힘듭니다. 이런 점 때문에 요즘 엔지니어들의 몸값이 비싸지는 것 같아요 ! 데이터 처리 데이터는 디..

const app = express(); // JSON null 필드 생략 app.set('json replacer', (k, v) => (v === null ? undefined : v)); 위와 같은 방법으로, 익스프레스에 json replacer를 정의해서 필요한 경우 null필드를 response에서 제외할 수 있습니다. ORM으로 sequelize나 type orm을 사용하는 경우에는 exclude, attributes 등을 사용해서 response를 원하는 범위로 조작할 수도 있습니다!

자식 테이블까지 Insert 하기 const result: Product = await Product.create(createProductDto, { include: includeStatement }); // ProducdtDto.ts export interface CreateProductDto { name: string; description?: string; count?: number; productImages?: ProductImageDto[]; } typescript 예시입니다. Sequelize의 include를 사용하면 관계를 맺고있는 자식 테이블까지 함께 insert를 칠 수 있습니다. hasOne이든 hasMany든 Sequelize가 그에 맞게 insert를 해줍니다 ! 상황에 다른 쿼리..

순서 컬럼? 일반적으로는 정렬을 id로 하지만, 특정 컬럼을 둬야 하는 경우가 생깁니다. 가령, 순서 수정이나 순서 변경 기능을 제공하는 백엔드에서 그렇죠. pk를 바꾸려면, 관련 테이블과 로그를 전부 수정해야 하기 때문이에요. 이 때는 순서 컬럼을 어떻게 두면 좋을까요? 방법 소개 stackoverflow를 통해, 존재하는 다양한 방법들을 살폈는데요. 대표적으로 4가지 방법이 있습니다. 1. 소수를 이용한 방법 2. bigint를 사용해서 bit hole을 두는 방법 3. next_id를 저장하는 방법 4. 기본적인 int를 저장하는 방법 비교 1. 소수를 이용한 방법의 경우 소수를 이용해서, 앞에 올 컬럼의 순서보다 0.01 정도씩 높여서 이동시키는 방법 적절하지만, 동작을 보장하지 않습니다. flo..

예시 어떤 엔터티에 대한 한 가지 컬럼에 대해서만 수정할 때 엔드포인트 설계를 어떻게 하면 좋을까요? 가령 어떤 품목(product)에 대한 예약(reservation)이 있다고 가정합니다. 예약(reservation)에는 승인 대기, 승인 완료, 반납 완료 - 총 3가지 상태가 있다고 가정합니다. 이런 세부 상태 등 하나의 컬럼을 변경하는 API를 설계하는 방법들에 대해서 알아보겠습니다. uri 비교 떠오르는 방법은 아래 5가지가 있습니다. PUT /bookings/{id} PATCH /bookings/{id} PUT /bookings/{id}/status PATCH /bookings/{id}/status POST /bookings/{id}/approve + POST /bookings/{id}/retu..

MySQL enum? ERD 설계, 엔터티 설계, DTO 설계를 할 때 고민되는 부분이 있습니다. enum vs boolean, enum vs tinyint 어떤 차이가 있을까요? 비교 ERD를 많이 보신 분들이라면, enum('Y', 'N')을 사용하는 경우를 종종 볼 수 있습니다. 상태(State) 또는 코드(Code)에서도 enum("CANCEL", "STOP", "COMPLETE")등을 사용하기도 합니다. 하지만, 이는 그리 좋은 방법이 아닐 수 있습니다. 왜 Why? Enum은 DB 비표준이자, MySQL의 확장입니다. 여기서 문제가 발생할 수 있습니다. 다른 종류의 DBMS로 마이그레이션이 불가능합니다. 지정된 문자열이 아닌 다른 문자열이 들어왔을 때 빈 문자열이 저장될 수 있습니다. 값이 변..

Boolean 명명 관례 Boolean 변수는 자바 등 각종 프로그래밍 언어 뿐만 아니라, 데이터 베이스에서도 많이 쓰입니다. Boolean 변수, 컬럼, 필드 등 이름은 어떻게 정하면 좋을까요? prefix 사용 의미에 따른 prefix를 활용합니다. (Is, Has, Can, Allows, should) is_activated is_available allows_booking 예시 1. 모든 경우가 참인지 확인하는 Boolean 값 (모든 유저들이 로그인을 했는지 여부) isUsersLoggedIn 🤨 문법이 틀림 areUsersLoggedIn 🤔 are보다는 is isEveryUserLoggedIn 👍 적절함 isEachUserLoggedIn 🥰 가장 적합함 2. 모든 경우 중 하나가 참인지 확인하..