커스텀 어노테이션으로 중복 코드 제거하기

기록하게된 이유

같은 기능을 수행하는 코드가  중복으로 여러 비즈니스 로직에 흩어져 있던 부분을 Spring AOP를 활용하여 해결한 내용을 기록한다.

 

이슈 사항

Open API를 운영하면서 응답 내 ID 필드가 마스킹이 누락되어 있어서 수정하려 소스를 확인해보니 어느 특정 API만 마스킹이 안되고 있었다.

모든 API들의 마스킹 로직을 전수 조사 해보니 다음과 같은 구조였다.

@Data
public class OrderDto {
	private String id;
    private String email;
    
    // ... 나머지 코드
    
    public String getId() {
    	return MaskingUtil.maskData(this.id, MaskingType.ID);
    }
    
    public String getEmail() {
        return MaskingUtil.maskData(this.email, MaskingType.EMAIL);
    }
}

@Data
public class UserDto {
	private String id;
    private String email;
    
    // ... 나머지 코드
    
    public String getId() {
    	return MaskingUtil.maskData(this.id, MaskingType.ID);
    }
    
    public String getEmail() {
    	return return username.charAt(0) + "***@" + domain;
    }
}


//서비스 내 비즈니스 로직 수행하는 메서드
public UserDto getUserInfoById(String id) {
	// ...나머지 코드
    
    UserDto user = userRepository.getUserInfo(String id);
    user.setId(MaskingUtil.maskData(this.id, MaskingType.ID));

	// ... 나머지 코드
}

 

같은 필드라도 서로 다른 dto라는 이유로 마스킹 수행 로직이 중복으로 구현되어 있었으며,
심지어 서비스 내 비즈니스 로직 내에서 마스킹을 하는 블록도 있었다.

 

개발 내용

마스킹 수행하는 관심사를 dto에서의 get()에서나 비즈니스 로직에서 분리하기 위해 AOP를 적용하여 코드 유지보수성을 높이고자 했다.

 

- 모든 API응답 객체에 일괄적으로 마스킹을 적용하기 위해 Serialization을 수행하는 ObjectMapper를 빈으로 등록한다.

@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();
        SimpleModule module = new SimpleModule();
        //SimpleModule을 생성하여 String.class 타입에 대해 커스텀 직렬화 로직(StringPropertyMasker)을 등록. 
        //모든 응답 문자열 데이터에 대해 지정된 마스킹 처리가 적용
        module.addSerializer(String.class, new StringPropertyMasker());
        objectMapper.registerModule(module);
        return objectMapper;
    }
}

 

- 마스킹이 필요한 필드에 어노테이션으로 마스킹 로직이 적용한다.

@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@JsonSerialize(using = StringPropertyMasker.class)
public @interface MaskJson {
    MaskingTypeEnum type(); // type() 속성을 통해 어떤 종류의 마스킹(MaskingTypeEnum)을 적용할지 설정
}

 

- String 타입의 직렬화를 커스터마이징

- @MarkJson이 적용된 필드를 모드 읽어 들이고 마스킹 타입을 동적으로 createContextual을 통해 할당한다.

public class StringPropertyMasker extends StdSerializer<String> implements ContextualSerializer {
    private MaskingTypeEnum maskingType;

    public StringPropertyMasker() {
        super(String.class);
    }
    
    protected StringPropertyMasker(MaskingTypeEnum maskingType) {
        super(String.class);
        this.maskingType = maskingType;
    }
    
    @Override
    public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) throws JsonMappingException {
        MaskingTypeEnum maskingTypeValue = null;
        MaskJson maskJson = null;
        if (property != null) {
            maskJson = property.getAnnotation(MaskJson.class);
        }
        if (maskJson != null) {
            maskingTypeValue = maskJson.type();
        }
        return new StringPropertyMasker(maskingTypeValue);
    }
    
    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider provider) throws IOException {
            gen.writeString(MaskingUtil.getMaskingData(value, maskingType));
        }
    }

 

이후 모든 마스킹처리는 필드에 @MaskJson으로만 적용한다.

@Data
public class OrderDto {
    @MaskJson(type = MaskingType.ID)
	private String id;
    @MaskJson(type = MaskingType.Email)
    private String email;
}

@Data
public class UserDto {
    @MaskJson(type = MaskingType.ID)
	private String id;
    @MaskJson(type = MaskingType.Email)
    private String email;
}