문서 추가

This commit is contained in:
이진기 2024-12-19 13:01:04 +09:00
parent 69d84c4706
commit 37bc3f423c
3 changed files with 77 additions and 0 deletions

40
java/README.md Normal file
View File

@ -0,0 +1,40 @@
### 기본 환경
- Java 11
- MyBatis 4.x
- JPA 2.2
- QueryDSL 5.0
### 개발 규약
- 사용하지 않는 Parameter는 넣지 않는다.
- Request, Response 호출은 EgovRequestUtils을 통해서만 한다.
- 관리자 Session 정보는 EgovAdminSessionUtils로 호출한다.(MultipartRequest는 제외)
- 사용자 Session 정보는 EgovUserSessionUtils로 호출한다.
- Spring context에서 벗어나게 개발하지 않는다.
### 어노테이션
- API Controller: @RestController
- Page Controller: @Controller
- Service: @Service
- Mapper: @Mapper
- DAO 또는 별도 컴포넌트들: @Component
### API URL 규약
- 대국민포털(prefix): 없음
- 참여기관/관리자포털(prefix): /admin
- 페이지: /**
- api: /api/**
- 메뉴 등록 시 full url로 기재할 것!
- 페이지 메뉴는 도메인으로 분기 처리되므로 동일 URL 사용 가능
- id 조회의 경우 반드시 query 처리할 것!
### DB 암호화
- 환경변수 추가 필요(안하면 에러 남)
- {project.baseDir}/main/resources/ksing/db 에 있는 모든 파일을 C:\SecureDBAgent 에 복사
- 아래의 정보로 환경변수 세팅 진행
- SDB_HOME / C:\SecureDBAgent
- SDB_FIRST_PORT / 9909
### 비지니스 로직 로깅 관련
- [필수] 비지니스 로직에 로깅할 경우 class 상단에 @Slf4j 어노테이션 선언
- [필수] Service에서는 전자정부프레임워크에서 제공하는 egovLogger를 사용

29
java/git.md Normal file
View File

@ -0,0 +1,29 @@
### 임시 git 설정(SSH 터널링)
```
ssh -i KLAC_SYS_ADM.pem -o ServerAliveInterval=60 -L 8081:localhost:8081 -L 5000:localhost:3000 rocky@192.168.30.7 -p 6722
```
### 브랜치 용도
- master: 운영 서버 반영 브랜치
- dev: 개발 서버 반영 브랜치
- mix: 개발용 브랜치
### 신규 브랜치 작성 방법
- feature/gitea아이디/번호
- 예) feature/natoro/1
- push 할 때마다 뒷 번호는 증가
### git 사용 방법
1. 작업하기 전 반드시 mix 브랜치에서 new branch로 생성
2. 작업이 완료될 경우 반드시 commit
3. 새로운 내용을 받을 때 pull(예: mix 브랜치 pull)
4. 작업한 내용을 서버에 올릴 때 push
5. 개발자는 merge 작업하지 말 것!
6. 작업 단위는 작게 진행(기능별로 분리해서 branch 작업)
7. 커미터, 기능별 태그 관리 및 버전 관리할 것
### 소스 관리 및 반영 관리(수정)
1. pull request 처리 주기
2. 코드 리뷰 주기
3. 반영 주기
4. 예) 수요일 - 오후 4시 pull request 처리

8
java/mapper.md Normal file
View File

@ -0,0 +1,8 @@
Mapper 사용 시 아래와 같이 작성(중괄호는 치환되는 명칭)
```
package: egovframework.com.lasp.{업무명}.mapper
Mapper파일명: {Admin | User}{업무명}Mapper.xml
annotation: org.egovframe.rte.psl.dataaccess.mapper.Mapper
xml파일: \resources\egovframework\sqlmap\mappers\{Mapper명과 동일}.xml
```