Han’s DevLog

response null 인 경우 생략

2023-02-24T00:00:00+00:00

Bean이 아닌 클래스에서 Bean을 주입이 필요한 경우 사용한다.

static 메서드나 new 를 사용하여 생성한 인스턴스에서 Bean을 해야하는 경우가 그 예다.

`ApplicationContextAware`

ApplicationContextAware 인터페이스를 구현 한다.

applicationContext 를 이용해 bean을 가져올 클래스를 정의하고 사용하면 된다.

import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

@Component
public class ApplicationContextProvider implements ApplicationContextAware {

    private static ApplicationContext context;

    @Override
    public void setApplicationContext(final ApplicationContext applicationContext) {
        context = applicationContext;
    }

    public static ApplicationContext getApplicationContext() {
        return context;
    }
}

@UtilityClass
public class ApplicationContextUtils {
    public static <T> @NotNull T getBean(final Class<T> type) {
        final ApplicationContext applicationContext = ApplicationContextProvider.getApplicationContext();
        return applicationContext.getBean(type);
    }
}

사용 예제

@Service
public class TestService {
    
    public void test() {
        System.out.println("Hello");
    }

}

public class StaticTest {
    
    public static check() {
        final Test test = ApplicationContextUtils.getBean(TestService.class).test(properties);
    }
}

response null 인 경우 생략

2023-02-15T00:00:00+00:00

1. DTO 마다 직접 적용 하는 경우

원하는 property 에 @JsonInclude(JsonInclude.Include.NON_NULL) 를 적용한다. 만약 @JsonInclude(JsonInclude.Include.NON_EMPTY) 를 적용하면 빈 문자열도 생략한다.

@Getter
@Setter
public class Demo implements Serializable {

    private Long id;

    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String name;

}

2. 전역 설정 하는 경우

직접 Bean 으로 등록하여 사용한다. JsonInclude.Include.NON_NULL 대신 JsonInclude.Include.NON_EMPTY 를 적용하면 빈 문자열도 생략한다.

@Configuration
public class MapperConfig {

    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); 
        return mapper;
    }
}

3. yaml 설정을 사용하는 경우

yaml 설정을 사용하는 경우에는 다음과 같이 설정한다.

spring:
  jackson:
    default-property-inclusion: non_null

Multi Module

2023-02-09T00:00:00+00:00

구성

root - app
     - auth

루트에는 아래 와 같이 setting.gradle.kts 등의 파일이 필요하나 서브 프로젝트에는 build.gradle.kts 만 있으면 된다.

root 의 build.gradle.kts

plugins {
    java
    id("org.springframework.boot") version "3.0.2"
    id("io.spring.dependency-management") version "1.1.0"
}

java.sourceCompatibility = JavaVersion.VERSION_17


allprojects {
    group = "com.demo"
    version = "0.0.1-SNAPSHOT"


    repositories {
        mavenCentral()
    }
}

subprojects {
    apply(plugin = "java")
    apply(plugin = "org.springframework.boot")
    apply(plugin = "io.spring.dependency-management")

    dependencies {
        implementation("org.springframework.boot:spring-boot-starter")
        testImplementation("org.springframework.boot:spring-boot-starter-test")
    }

    tasks.withType<Test> {
        useJUnitPlatform()
    }
}

project(":app") {
}

project(":auth") {
}

setting.gradle.kts

rootProject.name = "root"
include(
    "auth",
    "app"
)

app 의 build.gradle.kts

dependencies {
}

auth 의 build.gradle.kts

dependencies {
}

필요한 dependency 는 각 서브 프로젝트에서 추가하면 된다.

Introspection

2023-01-26T00:00:00+00:00

의미

JavaBean의 구조를 파악해 properties, methods 와 events를 파악
Reflection 기법을 사용하며 runtime에 진행된다.
introspect의 대상인 클래스를 JavaBean의 디자인 패턴에 맞게 작성해야 한다.
JavaBean의 properties, methods, events에 대해 추가적인 정보를 제공하고 싶으면 BeanInfo 인터페이스의 구현체를 제공하면 된다.

`Introspector`

JavaBean의 properties, methods, events를 분석하는 클래스이다.
BeanInfo가 제공되지 않는 경우, Introspector은 Reflection을 통해 JavaBean의 구조를 분석한다.
JavaBean의 BeanInfo 클래스들을 캐싱함으로써 성능을 높일 수 있다.

Serializable

2023-01-26T00:00:00+00:00

의미

자바 시스템 내부에서 사용하는 Object 또는 Data를 외부의 자바 시스템에서도 사용할 수 있도록 바이트 형태로 데이터를 변환하는 기술(JVM의 메모리에 상주되어 있는 객체 데이터를 바이트 형태로 변환)
다차원의 자료를 파일로 저장하거나 네트워크로 보내기에 알맞게 일차원으로 변환하고 다시 원래대로 되돌리는 것을 직렬화라고 한다.
역직렬화는 직렬화의 반대를 의미한다.(바이트 => data, object)

종류

`schematic`

데이터 모델이 고정되어 직렬화 포멧을 만들어두고 데이터 모델마다 생성해서 쓴다.
성능이나 크기를 기준으로 선택하는데 두가지 모두 schemaless 방법보다는 효율적이다.

`schemaless`

범용적인 데이터 모델에서 사용하는 접근 방법이다.
재귀가 없다는 특징을 가지고 있으며 순서 및 순열이 없는 집합만 가진다. (ex. JSON)

특징

Serializable를 구현하게 되면 직렬화 대상인 것을 JVM에게 알려주는 역할만 하기 때문에 구현해야하는 메서드는 존재 하지 않는다.
직렬화 작업이 아닌 직렬화 대상인 것을 알려주는 것이기에 성능상에 문제를 일으킬 가능성이 낮다.
자바 직렬화를 이용해서 외부 데이터를 저장하면 자바에서만 사용가능하다.

`serialVersionUID`

직렬화 과정에서 serialVersionUID가 포함 되고, 역직렬화 과정에서 Java class에 선언되어 있는 serialVersionUID의 버전과 서로 동일한지를 체크를 한다.
필수 값은 아니며 선언하지 않는 경우 클래스의 기본 해쉬 값을 사용한다.
컴파일러 구현에 따라 기본 해쉬 값이 달라지기 때문에 필수 값이 아니여도 직접 선언해 주는 것이 좋다.
잠재적으로 네트워크를 통해 전송되거나 파일로 저장할 가능성이 조금이라도 있는 클래스에 적용하는 것이 좋다.
멤버 변수명은 같은데 멤버 변수 타입이 바뀔 때, serialVersionUID를 변경하지 않으면 역직렬화 과정에서 에러가 발생한다.
원시 타입으로 변경하는 경우, properties 혹은 메서드가 삭제, 추가 되는 경우 serialVersionUID를 변경하지 않으면 역직렬화 과정에서 에러가 발생한다.

`enum`

enum의 모든 요소를 직렬화할 수 있는 경우 자동으로 직렬화한다.
enum에 직렬화할 수 없는 필드가 포함된 경우, 직렬화할 수 없다.
Serializable 인터페이스를 구현하여 명적으로 선언하는 경우 기본 구현 변경되더라도 일관되게 직렬화하고 역직렬화할 수 있도록 보장하는 데 도움이 된다.

`DTO`

네트워크나 디스크를 통해 직렬화가 필요한 형식으로 보내거나 저장하는 경우에는 직렬화하는 것이 좋다. 그렇지 않은 경우 직렬화할 필요가 없다.

`abstract`

직렬화가 필요하지 않은게 일반적이다.
abstract 클래스가 직렬화 가능한 클래스의 부모 클래스인 경우 부모 클래스의 상태도 자식 클래스의 상태의 일부이므로 자식 클래스가 직렬화된 경우에는 직렬화되어야 한다

Example

public class Demo implements Serializable {
    private static final long serialVersionUID = 1L;

    private String name;

    // getter, setter
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    protected Demo() {
        // 인자가 없는 public constructor
    }
}

JavaBean

2023-01-26T00:00:00+00:00

의미

Java 클래스 작성에 대한 표준 중 하나이다.

특징

모든 properties는 private 으로 가진다.
모든 properties는 public getter, setter을 설정해야 한다.
인자가 없는 public constructor을 가진다.
Serializable을 implement해야 합니다.
다양한 라이브러리에서 JavaBean의 특징인 Serializable을 활용해서 코드를 작성 할 수 있다.

구성 요소

Properties

JavaBean 규칙을 따른 클래스의 field
public getter와 public setter을 설정

Methods

Property 설정과 관련없는 JavaBean의 모든 public method

Events

JavaBean은 event를 발생시킬 수 으며, event는 다른 JavaBean의 메서드를 호출하는데 사용 가능하다.

Example

public class Demo implements Serializable {
    private static final long serialVersionUID = 1L;
    
    private String name;
    // getter, setter
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    
    protected Demo() {
        // 인자가 없는 public constructor
    }
}

인증 정보 저장에 로컬 스토리지 보다 쿠키를 선호하는 이유

2023-01-18T00:00:00+00:00

로컬 스토리지

장점

순수 자바 스크립트로 백엔드 없이 사용이 가능하다.
5mb 까지 저장이 가능하다.
단점
XSS 공격에 취약하다. 쿠키와 달리 브라우저에서 js로 직접 접근이 가능하기 때문이다.

쿠키

장점

httpOnly 와 보안된 쿠키를 사용한다면 js 를 이용하여 접근이 불가능하다. (XSS 로부터 안전하다는 의미는 아니다.)
서버에서 쿠키를 설정할 수 있다.
만료 날짜를 설정 할 수 있다.

단점

4kb 까지 저장이 가능하다.

결론

쿠키와 로컬 스토리지 모두 XSS 공격에 취약하다.
쿠키는 서버에서 설정이 가능하고 만료 날짜를 설정 할 수 있기 때문에 로컬 스토리지 보다 쿠키를 선호한다.
사이즈가 큰 경우 등이 있어 두 가지를 비교해 보고 사용하는 것이 유용하긴 하나 일반적으론 쿠키가 선호된다.

aop 사용한 로깅

2023-01-18T00:00:00+00:00

aop 를 활용한 로그를 남기려 한다.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/basic.xml"/>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%green(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%thread] %highlight(%-5level) %cyan(%logger{36}) - %msg%n
            </pattern>
        </layout>
    </appender>
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

point cut 으로 get post put delete 어노테이션이 있는 메서드들에 대해서 작동하도록 한다.

@Component
@Aspect
@Slf4j
@RequiredArgsConstructor
public class ApiLog {

    @Pointcut("@annotation(org.springframework.web.bind.annotation.GetMapping) ||" +
            "@annotation(org.springframework.web.bind.annotation.PostMapping) ||" +
            "@annotation(org.springframework.web.bind.annotation.PutMapping) ||" +
            "@annotation(org.springframework.web.bind.annotation.DeleteMapping)")
    public void logInfo() {
    }

    @Around(value = "logInfo()")
    public Object aspectGet(final ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        return this.getObject(proceedingJoinPoint);
    }

    private Object getObject(final @NotNull ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        final HttpServletRequest request =
                ((ServletRequestAttributes) Objects.requireNonNull(RequestContextHolder.getRequestAttributes()))
                        .getRequest();
        log.info("url : {}", request.getRequestURI());
    }
}

spring batch 5.0

2023-01-12T00:00:00+00:00

spring boot 3.0에서 spring batch 5.0이 추가되었다. spring batch 5.0 에서 기존에 아래와 같이 사용하던 방법이 deprecated 되었다.

1. 기존

@Configuration
@RequiredArgsConstructor
@Slf4j
public class MemberBatchJobConfig {
    private final JobBuilderFactory jobBuilderFactory;
    private final StepBuilderFactory stepBuilderFactory;

    private final MemberService memberService;


    @Value("${chunkSize:1000}")
    private int getChunkSize;

    @Bean
    public Job memberJob() {
        return jobBuilderFactory.get("memberJob")
                .start(memberStep())
                .build();
    }

    @Bean
    @JobScope
    public Step memberStep() {
        return this.stepBuilderFactory.get("memberStep")
                .<Member, Member>chunk(getChunkSize)
                .reader(this.memberReader())
                .writer(this.memberWireter())
                .build();
    }

    private ListItemReader<Member> memberReader() {
        return new ListItemReader<>(this.memberService.findAll());
    }

    @Bean
    public ItemWriter<Member> memberWriter() {
        return this::all;
    }

    private void all(final List<? extends Member> list) {
        list.forEach(item -> {
            log.info(item);
        });
    }
}

2. Spring Batch 5.0 에서의 방법

@EnableBatchProcessing
@Configuration
@EnableScheduling
public class Config {
    
}

@Configuration
@RequiredArgsConstructor
@Slf4j
public class CustomJobConfig extends DefaultBatchConfiguration {

    private final MemberService memberService;

    @Value("${chunkSize:1000}")
    private int getChunkSize;

    @Bean
    public Job job(final JobRepository jobRepository, final Step sendSmsStackStep) {
        return new JobBuilder("job", jobRepository)
                .start(sendSmsStackStep)
                .build();
    }

    @Bean
    public Step step(final JobRepository jobRepository,
                     final PlatformTransactionManager transactionManager) {
        return new StepBuilder("step", jobRepository)
                .chunk(this.getChunkSize, transactionManager)
                .reader(this.memberReader())
                .writer(this.memberWriter())
                .build();
    }

    private ListItemReader<Member> memberReader() {
        return new ListItemReader<>(this.memberService.getAllMember());
    }

    @Bean
    public ItemWriter<Object> memberWriter() {
        return this::loggingAll;
    }

    private void loggingAll(final Chunk<?> objects) {
        objects.getItems().forEach(item -> log.info(item.toString()));
    }


}

3. 참고

@Component
@RequiredArgsConstructor
public class JobScheduler {

    private final Job job;

    private final JobLauncher jobLauncher;

    @Scheduled(cron = "0 0 9 * * *", zone = "Asia/Seoul")
    public void nine() {
        this.schedulerRun(this.job);
    }


    private void schedulerRun(final Job job) {
        final Map<String, JobParameter<?>> stringJobParameterMap = new SoftHashMap<>();
        stringJobParameterMap.put("time", new JobParameter<>(System.currentTimeMillis(), Long.class));
        final JobParameters jobParameters = new JobParameters(stringJobParameterMap);
        try {
            this.jobLauncher.run(job, jobParameters);
        } catch (JobExecutionAlreadyRunningException | JobInstanceAlreadyCompleteException |
                 JobParametersInvalidException | JobRestartException e) {
            e.printStackTrace();
        }
    }
}

bucket4j 사용한 제어

2023-01-12T00:00:00+00:00

ehcache 를 사용하여 Bucket Sort Algorithm 을 사용하려 한다.

Refil

기본적으로 gready 는 정해진 시간 마다 지속적으로 리필을 해주는 형식이다. 반면에 intervally 는 한번에 리필을 해준다.

public class Bucket {
    Refill refill = Refill.greedy(10, Duration.ofSeconds(1));

    Refill refill = Refill.intervally(10, Duration.ofSeconds(1));
}

Bandwidth

버킷의 총량을 설정해 준다. simple 의 경우 greedy 를 사용하게 구현되어있다. classic 의 경우 Refill 의 구현체를 직접 사용한다.

public class Bucket {
    Bandwidth bandwidth = Bandwidth.simple(10, Duration.ofSeconds(1));
    Bandwidth bandwidth = Bandwidth.classic(10, Refill.greedy(10, Duration.ofSeconds(1)));
}

Bucket

컨트롤 하기 위해 사용할 객체이다.

public class Bucket {
    Bucket bucket = Bucket4j.builder()
            .addLimit(Bandwidth.simple(10, Duration.ofSeconds(1)))
            .build();
}

Example

ip 접근 제어의 경우 nginx 에서 설정을 제공하기도 하지만 spring 내에서 특정 API 접근에 대해서 처리하려고 한다.

아래의 라이브러리들을 추가해준다.

For java 11+

implementation(
    'com.bucket4j:bucket4j-core:8.1.0',
    'com.bucket4j:bucket4j-jcache:8.1.0',
    'org.ehcache:ehcache:3.10.8')

CacheManager 를 생성한다.

@Configuration
@EnableCaching
@EnableScheduling
@Slf4j
public class CacheConfig {

    private static final CacheManager cacheManager = Caching.getCachingProvider().getCacheManager();

    @Bean
    public Cache<String, byte[]> ipRateLimitCache() {
        return cacheManager.createCache("rateLimitCache", new MutableConfiguration<String, byte[]>()
                .setExpiryPolicyFactory(() -> new CreatedExpiryPolicy(Duration.ONE_DAY)));
    }

    // 0 시 마다 모든 캐시 초기화
    @Scheduled(cron = "0 0 0 * * *")
    public void clearCache() {
        cacheManager.getCacheNames().forEach(cacheName -> cacheManager.getCache(cacheName).clear());
        log.info("======= Clearing cache. =======");
    }
}

interceptor 를 생성한다.

@Slf4j
@Component
public class IpThrottlingInterceptor implements HandlerInterceptor {
    private static final String LOG_FORMAT = "ip: {}, rest token: {}";
    private static BucketConfiguration ofBuilder(final ConfigurationBuilder builder) {
        return builder.addLimit(Bandwidth.classic(5,
                Refill.intervally(5, Duration.ofDays(1L)))).build();
    }

    // cache for storing token buckets, where IP is key.
    private final ProxyManager<String> buckets;

    @Autowired
    public IpThrottlingInterceptor(final Cache<String, byte[]> ipRateLimitCache) {
        buckets = new JCacheProxyManager<>(ipRateLimitCache);
    }

    @Override
    public boolean preHandle(final @NotNull HttpServletRequest request, final @NotNull HttpServletResponse response,
                             final @NotNull Object handler) throws IOException {
        final String ip = IpAddressUtil.getClientIp(request);

        final Bucket bucket = this.ofBucket(ip);
        if (bucket.tryConsume(1)) {
            log.info(LOG_FORMAT, ip, bucket.getAvailableTokens());
            return true;
        }
        return this.error(ip, bucket, response);
    }

    private BucketProxy ofBucket(final String name) {
        return buckets.builder().build(name, IpThrottlingInterceptor.ofBuilder(
                BucketConfiguration.builder().addLimit(Bandwidth.classic(1,
                        Refill.greedy(1, Duration.ofMinutes(1))))));
    }

    private boolean error(final String ip, final @NotNull Bucket bucket,
                          final @NotNull HttpServletResponse response) throws IOException {
        log.error(LOG_FORMAT, ip, bucket.getAvailableTokens());
        response.sendError(HttpStatus.TOO_MANY_REQUESTS.value(), "To many requests");
        return false;
    }
}

인터셉터에 등록을 해주면 /api 로 접근하는 모든 요청에 대해 bucket 로직이 실행 된다.

@Configuration
@RequiredArgsConstructor
public class WebMvcConfig implements WebMvcConfigurer {

    private final IpThrottlingInterceptor ipThrottlingInterceptor;

    @Override
    public void addInterceptors(final InterceptorRegistry registry) {
        registry.addInterceptor(ipThrottlingInterceptor)
                .addPathPatterns("/api");
    }
}

Han’s DevLog

response null 인 경우 생략

ApplicationContextAware

사용 예제

response null 인 경우 생략

1. DTO 마다 직접 적용 하는 경우

2. 전역 설정 하는 경우

3. yaml 설정을 사용하는 경우

Multi Module

구성

root 의 build.gradle.kts

setting.gradle.kts

app 의 build.gradle.kts

auth 의 build.gradle.kts

Introspection

의미

Introspector

Serializable

의미

종류

schematic

schemaless

재귀가 없다는 특징을 가지고 있으며 순서 및 순열이 없는 집합만 가진다. (ex. JSON)

특징

serialVersionUID

enum

DTO

abstract

Example

JavaBean

의미

특징

구성 요소

Properties

Methods

Events

Example

인증 정보 저장에 로컬 스토리지 보다 쿠키를 선호하는 이유

로컬 스토리지

장점

단점

쿠키

장점

단점

결론

aop 사용한 로깅

spring batch 5.0

1. 기존

2. Spring Batch 5.0 에서의 방법

3. 참고

bucket4j 사용한 제어

Refil

Bandwidth

Bucket

Example

`ApplicationContextAware`

`Introspector`

`schematic`

`schemaless`

`serialVersionUID`

`enum`

`DTO`

`abstract`