스프링 생태계에 최상의 환경을 제공하는 것은 매우 중요합니다. 아래 가이드라인은 자바 표준 디자인 가이드라인 의 지침을 적절히 재정의하여 확장한 것입니다.

네임스페이스

✅ DO 모든 자바 패키지들은 com.azure.spring.<group>.<service>[.<feature>]과 같은 형식으로 명명되어야 합니다.

✅ DO 그룹, 서비스, 기능은 자바 기본 클라이언트 라이브러리에 사용되는 것과 동일하게 명명합니다.

✅ DO 모든 논-퍼블릭 API는 루트 네임스페이스에 속한 implementation 패키지에 위치시킵니다.

Maven

✅ DO 그룹 ID는 com.azure.spring를 사용합니다.

✅ DO artifactId 는 azure-spring-boot-starter-<group>-<service>[-<feature>]의 형태로 지정합니다. azure-spring-boot-starter-storage-blob 또는 azure-spring-boot-starter-security-keyvault-secrets와 같은 예시가 있습니다. 스프링 데이터 추상화의 경우, artifactId는 azure-spring-data-<group>-<service>[-<feature>]와 같은 형식이어야 합니다. 스프링 클라우드 스타터의 경우, artifactId는 azure-spring-cloud-starter-<group>-<service>[-<feature>]와 같은 형식이어야 합니다.

✅ DO Azure 스프링 라이브러리를 사용하는 사용자가 버전을 선택할 필요 없이 다른 Azure 자바 클라이언트 라이브러리에서 추가적인 종속성들을 가져올 수 있도록 dependencyManagement 종속성을 Azure 자바 SDK BOM에 포함합니다.

버전 관리

스프링 인티그레이션 모듈 버전 관리는 아래 목표들을 실현하도록 이뤄져야 합니다.

  1. 각각의 스프링 인티그레이션 모듈은 다른 릴리스 케이던스에서도 릴리스가 가능해야 합니다.
  2. 각각의 스프링 인티그레이션 모듈은 모든 릴리스에서 주 버전, 부 버전, 패치 버전이 모두 포함된 유의적 버전을 가져야 합니다. Azure 스프링 인티그레이션 모듈에서 그랬던 것처럼, 버전 관리가 스프링 종속성 버전에 연결되어 이뤄지면 안 됩니다.
  3. 개발자들이 사용할 스프링 인티그레이션 모듈을 쉽게 선택할 수 있도록 해야 합니다.

✅ DO 모든 스프링 인티그레이션 모듈은, 릴리스 시점을 기준으로, 상응하는 모든 스프링 API 활성 버전들을 지원합니다.

✅ DO 최신 릴리스 버전의 스프링 API 종속성을 스프링 인티그레이션 모듈 POM 파일에 추가합니다. 사용자들은 스스로 스프링 BOM을 통해 스프링 API 버전을 재정의해야 합니다.

✅ DO 스프링 인티그레이션 모듈이 모든 스프링 API 활성 버전들을 지원할 수 없는 경우 릴리스에 메이븐 분류자를 추가합니다. 예를 들어 스프링 인티그레이션 모듈이 Spring Boot 2.2x와 2.3.x을 지원해야 하지만 기술적인 제약으로 지원하지 못하는 경우 springboot_2_2와 springboot_2_3 분류자가 있는 두 가지 버전의 스프링 인티그레이션 모듈이 릴리스 돼야 합니다.

✅ DO 사용자들을 위해 스프링 인티그레이션 모듈 BOM을 제공합니다. 이 BOM은 같이 동작하는 것으로 알려진 모든 스프링 인티그레이션 모듈들의 버전을 반드시 포함해야 합니다(종속성 버전들에 대한 단일 집합을 포함해야 합니다). 또한 Azure 자바 SDK에 대한 적절한 참조 역시 포함돼야 합니다.

✅ DO 사용자들이 메이븐 분류자나 기타 버전 관리 문제들을 신경쓰지 않도록 그들이 선택한 스프링 버전에 대해, 특정 버전의 스프링 인트그레이션 모듈을 사용하기 보다는, 스프링 인티그레이션 모듈 BOM을 사용할 것을 권장합니다.

종속성

⛔️ DO NOT 자바 설계자와의 논의 없이 라이브러리에 대한 종속성을 도입하거나, 종속성 버전을 변경합니다. 각 종속성은 사용하기 전에 반드시 명시적인 승인을 받고 종속성 허용 목록에 추가돼야 합니다.

⛔️ DO NOT 스프링 라이브러리의 전이적 종속성들과 충돌하는 라이브러리 버전들에 대해 종속성을 도입합니다.

✅ DO com.azure 클라이언트 라이브러리만 사용해야 합니다 - 종속성 계층 구조에서 구 버전인 com.microsoft.azure 클라이언트 라이브러리를 혼용하지 마십시오.

✅ DO 최소한의 요구사항에 대한 종속성들을 유지해야 합니다.

로깅

⛔️ DO NOT ClientLogger 로깅 API를 사용해야 합니다.

추적

✅ DO 모든 Azure 스프링 라이브러리가 Azure 자바 클라이언트 라이브러리에서 사용 가능한 추적 기능들과 완전히 통합되는지 확인합니다.

✅ DO 모든 Azure 스프링 라이브러리가 스프링 Sleyth와 적절하게 동작하고, 추적 정보가 적절하게 내보내졌는지 확인합니다.

성능

✅ DO 적절한 벤치마크들(자바 SDK팀과 공동으로 개발)을 통해 모든 스프링 라이브러리의 성능이 자바 클라이언트에서 직접 실행하는 동일한 작업과 동등한 수준인지 확인합니다.