Skip to content

feat(school): 학교 클라이언트에 rate limiter 적용 #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
huhdy32 merged 3 commits into from
Jan 9, 2026
Merged

feat(school): 학교 클라이언트에 rate limiter 적용 #281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
631f886
feat(school): 학교 클라이언트에 rate limiter 적용
huhdy32 Jan 9, 2026
ae02b31
chore: 빠진 의존성 추가
huhdy32 Jan 9, 2026
762999d
Merge branch 'develop' into feat/school-rate-limiter
huhdy32 Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions client/external/mathrank-school/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'io.github.resilience4j:resilience4j-spring-boot3:2.2.0'
implementation 'org.springframework.boot:spring-boot-starter-aop'
implementation 'org.springframework.boot:spring-boot-starter-validation'
}
22 changes: 22 additions & 0 deletions ...nal/mathrank-school/src/main/java/kr/co/mathrank/client/external/school/SchoolClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import org.springframework.validation.annotation.Validated;
import org.springframework.web.client.RestClient;

import io.github.resilience4j.ratelimiter.annotation.RateLimiter;
import jakarta.validation.constraints.NotNull;
import kr.co.mathrank.client.config.RestClientResponseDecorator;
import kr.co.mathrank.client.config.TimeoutConfiguredClient;
Expand All @@ -19,7 +20,9 @@
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@Component
public class SchoolClient extends TimeoutConfiguredClient {
@Value("${neice.school.key:}")
Expand All @@ -39,6 +42,7 @@ public SchoolClient(final SchoolClientProperties schoolClientProperties) {
}

@Deprecated
@RateLimiter(name = "neiceApi", fallbackMethod = "fallBackSchoolInfo")
public Optional<SchoolInfo> getSchool(final String type, final String schoolCode) {
if (schoolCode == null || schoolCode.isBlank()) {
return Optional.empty();
Expand All @@ -58,11 +62,18 @@ public Optional<SchoolInfo> getSchool(final String type, final String schoolCode
return response.getSchoolInfo().isEmpty() ? Optional.empty() : Optional.of(response.getSchoolInfo().getFirst());
}

// fall back - #getSchool
private Optional<SchoolInfo> fallBackSchoolInfo(final String type, final String schoolCode, final Throwable t) {
log.warn("[SchoolClient.fallBackSchoolInfo] fallback called - type: {}, schoolCode: {}", type, schoolCode, t);
return Optional.empty();
}

public ClientResponse<Optional<SchoolInfo>> getSchoolResponse(final String type, final String schoolCode) {
return responseDecorator.wrap(() -> getSchool(type, schoolCode));
}

@Deprecated
@RateLimiter(name = "neiceApi", fallbackMethod = "fallBackGetSchools")
public SchoolResponse getSchools(String type, Integer pageIndex, Integer pageSize, String schoolName) {
return restClient.get()
.uri(uriBuilder -> uriBuilder.path("/hub/schoolInfo")
Expand All @@ -75,6 +86,11 @@ public SchoolResponse getSchools(String type, Integer pageIndex, Integer pageSiz
.body(SchoolResponse.class);
}

private SchoolResponse fallBackGetSchools(String type, Integer pageIndex, Integer pageSize, String schoolName, Throwable t) {
log.warn("[SchoolClient.fallBackGetSchools] fallback called - type: {}, pageIndex: {}, pageSize: {}, schoolName: {}", type, pageIndex, pageSize, schoolName, t);
return new SchoolResponse(null);
}

public ClientResponse<SchoolResponse> getSchoolsResponse(String type, Integer pageIndex, Integer pageSize, String schoolName) {
return responseDecorator.wrap(() -> this.getSchools(type, pageIndex, pageSize, schoolName));
}
Expand All @@ -88,6 +104,7 @@ public ClientResponse<SchoolResponse> getSchoolsResponse(String type, Integer pa
* @return 해당 도시의 학교 정보가 담긴 응답 객체
*/
@Deprecated
@RateLimiter(name = "neiceApi", fallbackMethod = "fallBackGetSchoolsByCityName")
public SchoolResponse getSchoolsByCityName(String type, String cityName) {
return restClient.get()
.uri(uriBuilder -> uriBuilder.path("/hub/schoolInfo")
Expand All @@ -101,6 +118,11 @@ public SchoolResponse getSchoolsByCityName(String type, String cityName) {
.body(SchoolResponse.class);
}

private SchoolResponse fallBackGetSchoolsByCityName(String type, String cityName, Throwable t) {
log.warn("[SchoolClient.fallBackGetSchoolsByCityName] fallback called - type: {}, cityName: {}", type, cityName, t);
return new SchoolResponse(null);
}

public ClientResponse<SchoolResponse> getSchoolsByCityNameResponse(String type, String cityName) {
return responseDecorator.wrap(() -> this.getSchoolsByCityName(type, cityName));
}
Expand Down
3 changes: 3 additions & 0 deletions ...mathrank-school/src/test/java/kr/co/mathrank/client/external/school/SchoolClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
@SpringBootTest(properties = """
client.school.read-timeout-seconds=10
client.school.connection-timeout-seconds=10
resilience4j.ratelimiter.instances.neiceApi.limit-refresh-period=1s
resilience4j.ratelimiter.instances.neiceApi.limit-for-period=100
resilience4j.ratelimiter.instances.neiceApi.timeout-duration=1s
""")
class SchoolClientTest {
@Autowired
Expand Down