소프트웨어-이야기 썸네일형 리스트형 ChatGPT으로 개발 디자인 문서 작성 속도 높이기: 빠르게 다이어그램 그리기 나는 ADR을 작성할 때, 다이어그램을 첨부하는 편이다. 그래야 재택근무를 하며 구두로 논의한 것들을 한눈에 파악하기 수월하다. 그런데 draw.io 같은 도구를 사용하면 반응이 느려 생산성이 떨어지기 때문에, 문서를 빠르게 작성하기 어렵다. 본 글에서는 간단한 개발 디자인 문서에 다이어그램을 빠르게 작성하는 방법을 설명하고자 한다. 1. 플레인 텍스트 언어로 다이어그램 그리기mermaid 혹은 plantUml 같은 플레인 텍스트 언어를 사용하면, 마치 마크다운 문법으로 다이어그램을 그리는 듯한 경험을 할 수 있다. (1) mermaid 맛보기mermaid를 사용하면, 다음과 같은 문법으로 다이어그램을 쉽게 그릴 수 있다. mermaid는 많은 에디터에서 지원하는 문법이고, 지원하는 다이어그램 유형이 다.. ChatGPT에게 IfNecessary, IfNeeded 함수명의 차이를 물어보다. 함수명의 접미사로 xxxIfNecessary, xxxIfNeeded를 사용하는 경우가 있다. 이는 특수한 조건에 해당하는 경우에만 함수를 실행하게 하는 경우 사용한다. 그러나 두 함수의 차이점이 무엇인지 궁금해져 chatgpt에게 물어보았다. 둘다 필요한 경우에 작업을 수행하도록 할 때 사용된다. 그러나 둘은 미묘한 차이가 있다. xxxIfNecessary 작업이 항상 실행되지는 않는다. 특정한 조건에 해당하는 경우에만 실행한다. // 필요한 경우에만 파일에 값을 쓰는 함수 writeToFileIfNecessary() // 필요한 경우에만 이메일을 발송하는 함수 sendEmailIfNecessary() xxxIfNeeded 작업이 항상 실행되는 경우에 사용한다. 항상 작업을 해야하지만, 프로그램 연산 비.. 디자인패턴 - Strategy Design Pattern Strategy Design Pattern 대부분의 기능은 동일하지만, 타입에 따라 일부 동작만 다르게 처리해야하는 경우, 유용한 디자인 패턴이다. 본 글에서는 결제 방법 (토스 혹은 포인트 결제)에 따라 장바구니 기능이 다르게 동작하는 예제를 설명할 것이다. Diagram Example public interface PaymentStrategy { public void pay(int amount); } public class PointStrategy implements PointStrategy { private String userId; public PointStrategy(String userId){ this.userId=userId; } @Override public void pay(int amou.. Enum 활용하기 Enum의 장점 public enum PizzaStatus { ORDERED, READY, DELIVERED; } Enum의 장점은 다음과 같다. 코드의 가독성을 높여준다. 허용하는 값의 목록을 문서화한다. 잘못된 값이 전달되는 문제를 줄일 수 있다. 실수를 줄여준다. Enum 비교하기 Enum은 ==, equals 함수로 비교할 수 있다. Enum은 JVM 에 한 개의 인스턴스만 생성되기 때문에 모든 Enum 객체는 동일한 주소값을 갖는다. testPz.getStatus().equals(Pizza.PizzaStatus.DELIVERED); testPz.getStatus() == Pizza.PizzaStatus.DELIVERED; Enum 활용하기 (1) Enum에 함수 추가하기 public enum P.. [다이어그램툴] excalidraw 온라인으로 다이어그램을 그릴 수 있는 gui 툴이다.draw.io 가 갑갑하고, mermaid 문법을 알기 싫다면, 사용해볼 법하다.단순한 다이어그램을 그리기 편하다.excalidraw 활용 사례는 다음과 같다. https://excalidraw.com/ Excalidraw — Collaborative whiteboarding made easyExcalidraw is a virtual collaborative whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.excalidraw.com Zalando 사례를 통해 REST API 가이드 살펴보기 zalando는 패션, 신발, 뷰티 부문을 판매하는 독일의 온라인 커머스 기업이다. zalando에서 작성한 Restful API 가이드의 몇가지 사례를 통해 좋은 API를 설계하는 방법을 정리해보고자 한다. https://opensource.zalando.com/restful-api-guidelines 설계 원칙 API가 첫번째이다. 기능을 구현하기 전에 API를 미리 설계해야한다. 클라이언트와 동료들에게 사전에 API 리뷰를 받아야한다. 추가로 API를 설계할 때 고려해야하는 점은 다음과 같다. 도메인과 기능의 목적을 제대로 이해해야한다. 일반화된 리소스를 제공해야한다. 특수한 사례별로 API를 제공하는 것은 피해야한다. API는 무엇을 제공하는지만 표현해야한다. 어떻게 기능을 제공하는지는 API에 .. Lombok 기본 생성자와 Getter/Builder 어노테이션 @Getter @Builder public class AddItemToCartCommand { private final Long userId; private final Long productId; private final Integer quantity; } Request DTO에 Getter, Builder 어노테이션만 추가하면, 다음과 같은 에러를 보게 되는 경우가 있다. Cannot construct instance of (no Creators, like default construct, exist): cannot deserialize from Object value (no delegate- or property-based Creator) 이번주에도 이 에러를 보게 되었다. 낯설지 않아서, 에러 노트.. JPA Entity와 Lombok Annotation java entity를 쓰다보면 Lombok annotation이 덕지덕지 붙게 된다. 요렇게 말이다. 👇🏻👇🏻 @AllArgsConstructor @NoargsConstructor(access = AccessLevel.PROTECTED) @Getter @Entity public class CartItem { ... 왜 annotation이 덕지덕지 붙게 되는건지, 왜 프로젝트마다 스타일이 다른건지 매번 까먹게 되어서 노션에 정리한걸 기록해보고자 한다. Context @Entity Entity를 사용하려면 JPA Proxy 기능 때문에 매개변수가 없는 기본 생성자가 필요하다. @Entity 어노테이션은 기본 생성자가 없는 경우, 알아서 기본 생성자를 만들어준다. 그래서 @NoArgsConstructor .. 이전 1 2 3 4 5 6 7 ··· 29 다음
