[Lehgo] SpringBoot Api-key 숨기는 방법, Properties Maven

💻 실습 환경

Framework: Spring Boot
Build: Maven

 

💬 요구 사항

Git을 이용해 프로젝트를 관리할때, 남들에게 보여지면 안되는 주요 정보가 있을 수 있다.

예를 들어 DB 아이디 비밀번호, APi Client Key 등등이 있을 수 있다. 이와 같은 정보들을 다른 이들에게 보이지 않게 관리하도록
Properties파일을 만들어 Key를 관리 할 수 있는 방법이 있다.

 

📌 application-API-KEY.properties 생성

아래와 같이 api key를 관리 할 수 있다.

properties명명 방식은 다음과 같다. application-[파일 이름].properties

<!- Naver API ->
NAVER-URL=https://nid.naver.com/oauth2.0
NAVER-CLIENT=AAAAAAAAAAAAA
NAVER-KEY=AAAAAAAAAAAAA
NAVER-CALLBACK=http://lehgo.site:9999/oauth/naver/callback

 

📌 application.properties 수정

/resources/application.properties 파일을 수정한다. application-API-KEY.properties 파일을 인식하도록한다.

아래 코드를 추가해주자.

#API KEYS
spring.profiles.include=API-KEY

 

📌 .gitignore 작성

.gitinore파일에 아래 코드를 추가해준다. 

# ignore properties file
application.properties
application-API-KEY.properties

 

📌 API KEY 사용 방법

.gitinore파일에 아래 코드를 추가해준다.

import org.springframework.beans.factory.annotation.Value;

public class GoogleOauth implements SocialOauth {
    // 발급받은 API 정보 
    @Value("${GOOGLE-CLIENT}")
    private String GOOGLE_CLIENT_ID;
    @Value("${GOOGLE-CALLBACK}")
    private String GOOGLE_CALLBACK_URL;
    @Value("${GOOGLE-KEY}")
    private String GOOGLE_KEY;

	....
}

 

 

👾 결과 화면

위의 방식으로 properties 파일을 숨기면, 서버를 띄운 내 환경에서는 properties 파일들이 잘 존재하고 있지만

 

git 페이지에서는 resource폴더에서 properties파일들이 없어진 것을 확인 할 수 있다.