readme 업데이트, AuditCommand 상속 받도록 수정 작업 중 ..
This commit is contained in:
89
README.md
89
README.md
@@ -240,6 +240,95 @@ fileUrlPortIn.getInline(
|
||||
`inline` 과 `attachment` 는 응답 헤더의 content-disposition 속성 값을 의미합니다.
|
||||
업로드된 파일은 사용자에게 전달할 때 `inline` 과 `attachment` 두 방식 중 요건에 맞게 사용하면 됩니다.
|
||||
|
||||
## 공통 필드(Audit) 자동 주입 방법 (AOP기반)
|
||||
createdAt, createdBy, updatedAt, updatedBy, deletedAt, deletedBy, isDeleted 와 같은 공통 이력 필드는
|
||||
매번 수동으로 설정하지 않아도 되도록, AOP를 활용해 자동으로 주입되도록 구성했습니다.
|
||||
|
||||
### 1. 기본 구조
|
||||
create, update, delete 시 Command 객체에 AuditCommand를 상속합니다.
|
||||
#### AuditCommand 사용 예시
|
||||
``` java
|
||||
// 필수: AuditCommand 상속
|
||||
public class UpdateCmd extends AuditCommand {
|
||||
private Long seq;
|
||||
...
|
||||
}
|
||||
```
|
||||
AuditCommand는 아래 메서드를 제공하며, 각각 생성/수정/삭제 작업에 필요한 필드를 자동으로 설정합니다.
|
||||
``` java
|
||||
public class AuditCommand {
|
||||
private LocalDateTime createdAt;
|
||||
private String createdBy;
|
||||
private LocalDateTime updatedAt;
|
||||
private String updatedBy;
|
||||
private LocalDateTime deletedAt;
|
||||
private String deletedBy;
|
||||
|
||||
public void create() { ... }
|
||||
public void update() { ... }
|
||||
public void delete() { ... }
|
||||
}
|
||||
```
|
||||
|
||||
### 2. AOP 기반 어노테이션 자동 주입
|
||||
service 또는 dao 내에
|
||||
@CreateCommand, @UpdateCommand, @DeleteCommand 어노테이션을 통해
|
||||
AOP가 자동으로 해당 메서드의 파라미터(AuditCommand 상속 객체)에 공통 필드를 주입합니다.
|
||||
|
||||
| 어노테이션 | 자동 설정되는 필드 |
|
||||
| ---------------- | -------------------------------------------------- |
|
||||
| `@CreateCommand` | `createdAt`, `createdBy`, `updatedAt`, `updatedBy` |
|
||||
| `@UpdateCommand` | `updatedAt`, `updatedBy` |
|
||||
| `@DeleteCommand` | `updatedAt`, `updatedBy`, `deletedAt`, `deletedBy` |
|
||||
|
||||
#### 어노테이션 사용 예시
|
||||
```java
|
||||
@UpdateCommand
|
||||
public void operate(UpdateCmd cmd) {
|
||||
mapper.update(cmd);
|
||||
}
|
||||
```
|
||||
### 3. AOP 외 수동 적용이 필요한 경우: AuditUtil 사용
|
||||
AOP 외에도, 하나의 DAO 메서드 내에서 여러 Insert/Delete 처리가 필요한 경우에는 아래처럼 직접 AuditUtil을 사용할 수 있습니다.
|
||||
#### AuditUtil 사용 예시
|
||||
```java
|
||||
// 관리자 등록
|
||||
mapper.insertAdmin(AuditUtil.create(cmd));
|
||||
|
||||
// 관리자의 역할 매핑
|
||||
mapper.insertAdminHasRoles(
|
||||
AuditUtil.create(new SaveAdminHasRoleParam(cmd.getSeq(), cmd.getRoleIds()))
|
||||
);
|
||||
```
|
||||
|
||||
### 4. XML에서 공통 필드 include로 재사용
|
||||
SQL 작성 시 공통필드의 반복 작성을 피하기 위해 `<sql>` 태그로 분리하여 `<include>` 방식으로 재사용합니다.
|
||||
자세한 정의는 `CommonFieldsMapper.xml` 파일에서 확인할 수 있습니다.
|
||||
|
||||
| SQL ID | 설명 | 사용 예시 |
|
||||
| ---------------------------- | -------------------------------------- | -------------------------------------------------------------- |
|
||||
| `CreateUpdateBaseColumns` | `INSERT` 시 공통 컬럼 정의 | `<include refid="common.fields.CreateUpdateBaseColumns" />` |
|
||||
| `CreateUpdateBaseValues` | `INSERT` 시 공통 컬럼의 값 정의 | `<include refid="common.fields.CreateUpdateBaseValues" />` |
|
||||
| `CreateUpdateListBaseValues` | `다건 INSERT` 시 공통 값 정의 (e.g. `foreach`) | `<include refid="common.fields.CreateUpdateListBaseValues" />` |
|
||||
| `UpdateBaseSet` | `UPDATE` 시 공통 `SET` 구문 | `<include refid="common.fields.UpdateBaseSet" />` |
|
||||
| `DeleteBaseSet` | `삭제 처리용 UPDATE` 시 공통 `SET` 구문 | `<include refid="common.fields.DeleteBaseSet" />` |
|
||||
|
||||
#### include 사용 예시
|
||||
```xml
|
||||
UPDATE household
|
||||
SET
|
||||
owner_name = #{ownerName},
|
||||
owner_age = #{ownerAge},
|
||||
tel = #{tel},
|
||||
phone = #{phone},
|
||||
region = #{region},
|
||||
city = #{city},
|
||||
address_detail = #{addressDetail},
|
||||
<include refid="common.fields.UpdateBaseSet" /> <!-- 공통 필드 include -->
|
||||
WHERE seq = ${seq}
|
||||
```
|
||||
|
||||
|
||||
## PACKAGING
|
||||
|
||||
배포방식 설정을 위해 두가지 maven 프로파일을 제공한다.
|
||||
|
||||
Reference in New Issue
Block a user