자바로 코드를 짜다보면 @override를 많이 보게 된다. 볼 때마다 생각했던 것인데, overriding되 있는거 명시 안해줘도 다 아는데 왜 굳이 써놓았을까? 라는 의문이었다. 

그러다, 이번에 bean에 대해 배우면서 @(어노테이션) 을 많이 보게 되었다. 이 포스팅에서는 어노테이션이 무엇인지에 대해 알아본다. 

Annotation

= 컴파일러와 개발자에게 추가적인 정보를 제공하는 메타데이터

프로그램 코드의 일부가 아닌, 프로그램에 관한 데이터를 제공하고, 코드에 정보를 추가하는 정형화된 방법

<사용 이유>

1. 컴파일러 체크
   예를 들어, @Override를 붙이면 컴파일러가 해당 메서드가 상위 클래스나 인터페이스의 메서드를 올바르게 오버라이딩 하고 있는지 검사
   오타나 시그니처가 틀릴 시. 컴파일 오류를 발생
2. 가독성 및 문서화
   코드의 의도를 명확하게 표현하여 역할을 바로 알 수 있음
   → 유지보수와 협업에 도움이 됨
3. 부가 기능 제공
   Spring, JPA 등 다양한 프레임워크에서는 어노테이션을 활용하여 런타임에 객체를 자동으로 생성하거나 특정 동작을 수행하도록 함
   → 코드를 간결하게 유지 & 복잡한 설정이나 동작을 자동화

어노테이션에는 굉장히 많은 종류가 있다. 그 중 잘 쓰이는 몇 가지를 알아보자.

@override

메서드가 슈퍼클래스(또는 인터페이스)의 메서드를 재정의(override)하고 있음을 컴파일러에 알려줌

@SpringBootApplication

Srping Boot를 자동으로 실행시켜주는 어노테이션

Bean을 정의하고 등록하는 3가지 어노테이션을 포함한다.

• @Configuration: 해당 클래스가 Spring 설정 파일임을 선언합니다.
• @EnableAutoConfiguration: 미리 정의된 설정들을 바탕으로 자동으로 Bean들을 등록해줍니다.
• @ComponentScan: 지정된 패키지(기본적으로 현재 클래스가 위치한 패키지 및 하위 패키지) 내의 컴포넌트를 검색하여 Bean으로 등록합니다.

🎀 Spring 설정 파일
    = Bean을 정의 & 구성
    - XML 설정 파일(구 방식)
       스프링 컨테이너에게 어떤 빈들을 어떻게 생성하고 연결할지를 알려주는 설정 리소스
    - Java Config(최신 방식)
       @Configuration과 그 안의 @Bean 메서드들을 사용하면, 해당 메서드들이 반환하는 객체들이 bean으로 등록됨 

@ComponentScan

직접 작성한 class를 bean으로 등록

→ value를 이용해 bean의 이름을 지정

@Bean

개발자가 제어 불가한 클래스(ex. 외부 라이브러리)를 bean으로 등록

→ name을 이용해 bean의 이름을 지정

@Controller

Spring MVC의 Controller로 사용되는, 클래스 선언을 단순화 시켜주는 어노테이션

@RestController

Spring에서 Controller 중 View로 응답하지 않는 Controller를 의미한다.

method의 반환 결과를 JSON 형태로 반환한다.

⇒ @Controller + @ResponseBody

커뮤니티 프로젝트를 진행하며 프론트엔드 개발을 완료한 후, 이제 API를 연동하는 단계입니다.

본 포스팅에서는 API의 개념부터 명세서 작성법, 그리고 실제 예시까지 자세히 알아보자.

API

(Application Programming Interface)

소프트웨어 애플리케이션이 서로 통신하여 데이터, 특징 및 기능을 교환할 수 있도록 하는 일련의 규칙 또는 프로토콜

• 클라이언트와 서버 사이의 요청 및 응답에서 API 통신이 사용된다.
• API는 이 연결을 설정하는 bridge
• 어려운 기술을 요하는 기능을 직접 개발하지 않고 편리하게 사용 가능

API 명세서

API에 대한 설명을 자세하게 적어놓은 문서

HTTP Method 종류(GET, POST, PUT, PATCH, DELETE…), 엔드포인트, 데이터, HTTP status 등을 포함한다.

📌 HTTP 주요 메서드 정리

메서드 설명 주요 기능 예시

📌 API 설계에서 자주 사용하는 HTTP 상태 코드 정리

상태 코드 의미 설명 예시

API 설계도 작성법

<요청>

1. Request Syntax
     API의 형태, 구조에 대한 정의
   ex) API가 사용하는 메서드 & 요청 URL의 형태 & 코드 예제 제공
2. Request Header
     요청에 대한 추가 정보
   ex) 메시지의 총 길이, 형식, 인증을 위한 정보 등…
3. Request Element
     요청의 실제 메시지 (→GET에는 없음)
   ex) 파라미터, 파라미터의 유형, 필수 여부, 설명, 제약 사항 등…

<응답>

1. Response Element
     API 요청에 대한 결과값 확인
   ex) 성공 여부, 조회 정보

예시.

🌸 환영합니다! 🌸

이 곳은 제가 배운 것들을 공유하는 공간입니다! 

💗 개발 공부하면서 배운 것들
💗 프로젝트 이야기들

💗 회고와 작은 이야기들

자주 놀러 와 주세요! 🎀💌

이 블로그는 개인 공부 및 기록을 위해 작성되었습니다. 피드백은 언제나 환영합니다.

tailwindCSS를 사용해 보려고 하다가 문득 이게 뭐지? 하는 의문이 들었다.... 정리를 해보자.

Bootstrap

https://getbootstrap.kr/

무료 or 유료로 사용 가능한 미리 만들어진 컴포넌트들을 파는 마켓.

로컬에 설치 후 마켓에 등록되어 있는 클래스 명을 가져와 사용할 수 있다.

• 컴포넌트 기반: 미리 디자인된 UI 컴포넌트(버튼, 네비게이션, 모달 등)를 제공합니다.
• 빠른 프로토타이핑: 표준화된 디자인과 컴포넌트를 활용하여 빠르게 웹사이트를 구축할 수 있습니다.
• 일관된 디자인: 기본 제공하는 스타일 덕분에 전체적인 디자인의 일관성을 쉽게 유지할 수 있습니다.
• 커스터마이징 한계: 기본 스타일을 재정의하거나 커스터마이징 하려면 CSS나 Sass 변수 등을 수정해야 합니다.
• 클래스 이름: 컴포넌트 이름 기반의 클래스(예: btn, navbar)를 사용합니다.

Tailwind CSS

https://tailwindcss.com/

작성이 쉽도록 정해놓은 css 규칙을 정의

로컬에 설치 후 사용

• 유틸리티 우선(Utility-First): 미리 정의된 작은 단위의 클래스들(예: p-4, text-center, bg-blue-500)을 조합하여 디자인합니다.
• 높은 커스터마이징: 기본 디자인이 거의 없으며, 유틸리티 클래스를 조합해 자유롭게 디자인할 수 있습니다.
• 재사용성 및 유지보수: 코드의 재사용성과 수정이 용이하지만, 클래스가 HTML 요소에 많이 붙어 길어질 수 있습니다.
• 퍼포먼스 최적화: PurgeCSS 같은 도구를 이용해 사용하지 않는 CSS를 제거하여 최종 빌드 크기를 줄일 수 있습니다.
• 개발자 경험: 디자인의 유연성과 커스터마이징을 중시하는 개발자에게 인기가 많습니다.