Init
This commit is contained in:
Canos
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
/mvnw text eol=lf
|
||||||
|
*.cmd text eol=crlf
|
||||||
33
.gitignore
vendored
Normal file
33
.gitignore
vendored
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
HELP.md
|
||||||
|
target/
|
||||||
|
.mvn/wrapper/maven-wrapper.jar
|
||||||
|
!**/src/main/**/target/
|
||||||
|
!**/src/test/**/target/
|
||||||
|
|
||||||
|
### STS ###
|
||||||
|
.apt_generated
|
||||||
|
.classpath
|
||||||
|
.factorypath
|
||||||
|
.project
|
||||||
|
.settings
|
||||||
|
.springBeans
|
||||||
|
.sts4-cache
|
||||||
|
|
||||||
|
### IntelliJ IDEA ###
|
||||||
|
.idea
|
||||||
|
*.iws
|
||||||
|
*.iml
|
||||||
|
*.ipr
|
||||||
|
|
||||||
|
### NetBeans ###
|
||||||
|
/nbproject/private/
|
||||||
|
/nbbuild/
|
||||||
|
/dist/
|
||||||
|
/nbdist/
|
||||||
|
/.nb-gradle/
|
||||||
|
build/
|
||||||
|
!**/src/main/**/build/
|
||||||
|
!**/src/test/**/build/
|
||||||
|
|
||||||
|
### VS Code ###
|
||||||
|
.vscode/
|
||||||
19
.mvn/wrapper/maven-wrapper.properties
vendored
Normal file
19
.mvn/wrapper/maven-wrapper.properties
vendored
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Licensed to the Apache Software Foundation (ASF) under one
|
||||||
|
# or more contributor license agreements. See the NOTICE file
|
||||||
|
# distributed with this work for additional information
|
||||||
|
# regarding copyright ownership. The ASF licenses this file
|
||||||
|
# to you under the Apache License, Version 2.0 (the
|
||||||
|
# "License"); you may not use this file except in compliance
|
||||||
|
# with the License. You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing,
|
||||||
|
# software distributed under the License is distributed on an
|
||||||
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||||
|
# KIND, either express or implied. See the License for the
|
||||||
|
# specific language governing permissions and limitations
|
||||||
|
# under the License.
|
||||||
|
wrapperVersion=3.3.2
|
||||||
|
distributionType=only-script
|
||||||
|
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.10/apache-maven-3.9.10-bin.zip
|
||||||
44
build-and-deploy.sh
Normal file
44
build-and-deploy.sh
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Build and Deploy Script for Erato Rate Limit Starter
|
||||||
|
|
||||||
|
echo "🚀 Building Erato Rate Limit Spring Boot Starter..."
|
||||||
|
|
||||||
|
# Clean and build
|
||||||
|
mvn clean install
|
||||||
|
|
||||||
|
# Run tests
|
||||||
|
echo "🧪 Running tests..."
|
||||||
|
mvn test
|
||||||
|
|
||||||
|
# Package
|
||||||
|
echo "📦 Packaging..."
|
||||||
|
mvn package
|
||||||
|
|
||||||
|
# Install to local repository
|
||||||
|
echo "💾 Installing to local Maven repository..."
|
||||||
|
mvn install
|
||||||
|
|
||||||
|
# Deploy to private repository (adjust URL)
|
||||||
|
echo "🌐 Deploying to repository..."
|
||||||
|
mvn deploy -DaltDeploymentRepository=erato-repo::default::https://nexus.erato.com.tr/repository/maven-releases/
|
||||||
|
|
||||||
|
# Generate documentation
|
||||||
|
echo "📚 Generating documentation..."
|
||||||
|
mvn javadoc:javadoc
|
||||||
|
|
||||||
|
echo "✅ Build and deploy completed!"
|
||||||
|
|
||||||
|
# Optional: Create release package
|
||||||
|
echo "📦 Creating release package..."
|
||||||
|
mkdir -p release
|
||||||
|
cp target/erato-rate-limit-spring-boot-starter-*.jar release/
|
||||||
|
cp README.md release/
|
||||||
|
cp -r target/site/apidocs release/javadoc
|
||||||
|
|
||||||
|
# Create zip
|
||||||
|
cd release
|
||||||
|
zip -r erato-rate-limit-starter-1.0.0.zip *
|
||||||
|
cd ..
|
||||||
|
|
||||||
|
echo "🎉 Release package created: release/erato-rate-limit-starter-1.0.0.zip"
|
||||||
259
mvnw
vendored
Normal file
259
mvnw
vendored
Normal file
@@ -0,0 +1,259 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# ----------------------------------------------------------------------------
|
||||||
|
# Licensed to the Apache Software Foundation (ASF) under one
|
||||||
|
# or more contributor license agreements. See the NOTICE file
|
||||||
|
# distributed with this work for additional information
|
||||||
|
# regarding copyright ownership. The ASF licenses this file
|
||||||
|
# to you under the Apache License, Version 2.0 (the
|
||||||
|
# "License"); you may not use this file except in compliance
|
||||||
|
# with the License. You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing,
|
||||||
|
# software distributed under the License is distributed on an
|
||||||
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||||
|
# KIND, either express or implied. See the License for the
|
||||||
|
# specific language governing permissions and limitations
|
||||||
|
# under the License.
|
||||||
|
# ----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
# ----------------------------------------------------------------------------
|
||||||
|
# Apache Maven Wrapper startup batch script, version 3.3.2
|
||||||
|
#
|
||||||
|
# Optional ENV vars
|
||||||
|
# -----------------
|
||||||
|
# JAVA_HOME - location of a JDK home dir, required when download maven via java source
|
||||||
|
# MVNW_REPOURL - repo url base for downloading maven distribution
|
||||||
|
# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven
|
||||||
|
# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output
|
||||||
|
# ----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
set -euf
|
||||||
|
[ "${MVNW_VERBOSE-}" != debug ] || set -x
|
||||||
|
|
||||||
|
# OS specific support.
|
||||||
|
native_path() { printf %s\\n "$1"; }
|
||||||
|
case "$(uname)" in
|
||||||
|
CYGWIN* | MINGW*)
|
||||||
|
[ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")"
|
||||||
|
native_path() { cygpath --path --windows "$1"; }
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
# set JAVACMD and JAVACCMD
|
||||||
|
set_java_home() {
|
||||||
|
# For Cygwin and MinGW, ensure paths are in Unix format before anything is touched
|
||||||
|
if [ -n "${JAVA_HOME-}" ]; then
|
||||||
|
if [ -x "$JAVA_HOME/jre/sh/java" ]; then
|
||||||
|
# IBM's JDK on AIX uses strange locations for the executables
|
||||||
|
JAVACMD="$JAVA_HOME/jre/sh/java"
|
||||||
|
JAVACCMD="$JAVA_HOME/jre/sh/javac"
|
||||||
|
else
|
||||||
|
JAVACMD="$JAVA_HOME/bin/java"
|
||||||
|
JAVACCMD="$JAVA_HOME/bin/javac"
|
||||||
|
|
||||||
|
if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then
|
||||||
|
echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2
|
||||||
|
echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
JAVACMD="$(
|
||||||
|
'set' +e
|
||||||
|
'unset' -f command 2>/dev/null
|
||||||
|
'command' -v java
|
||||||
|
)" || :
|
||||||
|
JAVACCMD="$(
|
||||||
|
'set' +e
|
||||||
|
'unset' -f command 2>/dev/null
|
||||||
|
'command' -v javac
|
||||||
|
)" || :
|
||||||
|
|
||||||
|
if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then
|
||||||
|
echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# hash string like Java String::hashCode
|
||||||
|
hash_string() {
|
||||||
|
str="${1:-}" h=0
|
||||||
|
while [ -n "$str" ]; do
|
||||||
|
char="${str%"${str#?}"}"
|
||||||
|
h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296))
|
||||||
|
str="${str#?}"
|
||||||
|
done
|
||||||
|
printf %x\\n $h
|
||||||
|
}
|
||||||
|
|
||||||
|
verbose() { :; }
|
||||||
|
[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; }
|
||||||
|
|
||||||
|
die() {
|
||||||
|
printf %s\\n "$1" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
trim() {
|
||||||
|
# MWRAPPER-139:
|
||||||
|
# Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds.
|
||||||
|
# Needed for removing poorly interpreted newline sequences when running in more
|
||||||
|
# exotic environments such as mingw bash on Windows.
|
||||||
|
printf "%s" "${1}" | tr -d '[:space:]'
|
||||||
|
}
|
||||||
|
|
||||||
|
# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties
|
||||||
|
while IFS="=" read -r key value; do
|
||||||
|
case "${key-}" in
|
||||||
|
distributionUrl) distributionUrl=$(trim "${value-}") ;;
|
||||||
|
distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;;
|
||||||
|
esac
|
||||||
|
done <"${0%/*}/.mvn/wrapper/maven-wrapper.properties"
|
||||||
|
[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.mvn/wrapper/maven-wrapper.properties"
|
||||||
|
|
||||||
|
case "${distributionUrl##*/}" in
|
||||||
|
maven-mvnd-*bin.*)
|
||||||
|
MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/
|
||||||
|
case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in
|
||||||
|
*AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;;
|
||||||
|
:Darwin*x86_64) distributionPlatform=darwin-amd64 ;;
|
||||||
|
:Darwin*arm64) distributionPlatform=darwin-aarch64 ;;
|
||||||
|
:Linux*x86_64*) distributionPlatform=linux-amd64 ;;
|
||||||
|
*)
|
||||||
|
echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2
|
||||||
|
distributionPlatform=linux-amd64
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip"
|
||||||
|
;;
|
||||||
|
maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;;
|
||||||
|
*) MVN_CMD="mvn${0##*/mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
# apply MVNW_REPOURL and calculate MAVEN_HOME
|
||||||
|
# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-<version>,maven-mvnd-<version>-<platform>}/<hash>
|
||||||
|
[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}"
|
||||||
|
distributionUrlName="${distributionUrl##*/}"
|
||||||
|
distributionUrlNameMain="${distributionUrlName%.*}"
|
||||||
|
distributionUrlNameMain="${distributionUrlNameMain%-bin}"
|
||||||
|
MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}"
|
||||||
|
MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")"
|
||||||
|
|
||||||
|
exec_maven() {
|
||||||
|
unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || :
|
||||||
|
exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD"
|
||||||
|
}
|
||||||
|
|
||||||
|
if [ -d "$MAVEN_HOME" ]; then
|
||||||
|
verbose "found existing MAVEN_HOME at $MAVEN_HOME"
|
||||||
|
exec_maven "$@"
|
||||||
|
fi
|
||||||
|
|
||||||
|
case "${distributionUrl-}" in
|
||||||
|
*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;;
|
||||||
|
*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
# prepare tmp dir
|
||||||
|
if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then
|
||||||
|
clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; }
|
||||||
|
trap clean HUP INT TERM EXIT
|
||||||
|
else
|
||||||
|
die "cannot create temp dir"
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p -- "${MAVEN_HOME%/*}"
|
||||||
|
|
||||||
|
# Download and Install Apache Maven
|
||||||
|
verbose "Couldn't find MAVEN_HOME, downloading and installing it ..."
|
||||||
|
verbose "Downloading from: $distributionUrl"
|
||||||
|
verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName"
|
||||||
|
|
||||||
|
# select .zip or .tar.gz
|
||||||
|
if ! command -v unzip >/dev/null; then
|
||||||
|
distributionUrl="${distributionUrl%.zip}.tar.gz"
|
||||||
|
distributionUrlName="${distributionUrl##*/}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# verbose opt
|
||||||
|
__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR=''
|
||||||
|
[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v
|
||||||
|
|
||||||
|
# normalize http auth
|
||||||
|
case "${MVNW_PASSWORD:+has-password}" in
|
||||||
|
'') MVNW_USERNAME='' MVNW_PASSWORD='' ;;
|
||||||
|
has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then
|
||||||
|
verbose "Found wget ... using wget"
|
||||||
|
wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl"
|
||||||
|
elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then
|
||||||
|
verbose "Found curl ... using curl"
|
||||||
|
curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl"
|
||||||
|
elif set_java_home; then
|
||||||
|
verbose "Falling back to use Java to download"
|
||||||
|
javaSource="$TMP_DOWNLOAD_DIR/Downloader.java"
|
||||||
|
targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName"
|
||||||
|
cat >"$javaSource" <<-END
|
||||||
|
public class Downloader extends java.net.Authenticator
|
||||||
|
{
|
||||||
|
protected java.net.PasswordAuthentication getPasswordAuthentication()
|
||||||
|
{
|
||||||
|
return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() );
|
||||||
|
}
|
||||||
|
public static void main( String[] args ) throws Exception
|
||||||
|
{
|
||||||
|
setDefault( new Downloader() );
|
||||||
|
java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() );
|
||||||
|
}
|
||||||
|
}
|
||||||
|
END
|
||||||
|
# For Cygwin/MinGW, switch paths to Windows format before running javac and java
|
||||||
|
verbose " - Compiling Downloader.java ..."
|
||||||
|
"$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java"
|
||||||
|
verbose " - Running Downloader.java ..."
|
||||||
|
"$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If specified, validate the SHA-256 sum of the Maven distribution zip file
|
||||||
|
if [ -n "${distributionSha256Sum-}" ]; then
|
||||||
|
distributionSha256Result=false
|
||||||
|
if [ "$MVN_CMD" = mvnd.sh ]; then
|
||||||
|
echo "Checksum validation is not supported for maven-mvnd." >&2
|
||||||
|
echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2
|
||||||
|
exit 1
|
||||||
|
elif command -v sha256sum >/dev/null; then
|
||||||
|
if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c >/dev/null 2>&1; then
|
||||||
|
distributionSha256Result=true
|
||||||
|
fi
|
||||||
|
elif command -v shasum >/dev/null; then
|
||||||
|
if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then
|
||||||
|
distributionSha256Result=true
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2
|
||||||
|
echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ $distributionSha256Result = false ]; then
|
||||||
|
echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2
|
||||||
|
echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# unzip and move
|
||||||
|
if command -v unzip >/dev/null; then
|
||||||
|
unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip"
|
||||||
|
else
|
||||||
|
tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar"
|
||||||
|
fi
|
||||||
|
printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url"
|
||||||
|
mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME"
|
||||||
|
|
||||||
|
clean || :
|
||||||
|
exec_maven "$@"
|
||||||
149
mvnw.cmd
vendored
Normal file
149
mvnw.cmd
vendored
Normal file
@@ -0,0 +1,149 @@
|
|||||||
|
<# : batch portion
|
||||||
|
@REM ----------------------------------------------------------------------------
|
||||||
|
@REM Licensed to the Apache Software Foundation (ASF) under one
|
||||||
|
@REM or more contributor license agreements. See the NOTICE file
|
||||||
|
@REM distributed with this work for additional information
|
||||||
|
@REM regarding copyright ownership. The ASF licenses this file
|
||||||
|
@REM to you under the Apache License, Version 2.0 (the
|
||||||
|
@REM "License"); you may not use this file except in compliance
|
||||||
|
@REM with the License. You may obtain a copy of the License at
|
||||||
|
@REM
|
||||||
|
@REM http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
@REM
|
||||||
|
@REM Unless required by applicable law or agreed to in writing,
|
||||||
|
@REM software distributed under the License is distributed on an
|
||||||
|
@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||||
|
@REM KIND, either express or implied. See the License for the
|
||||||
|
@REM specific language governing permissions and limitations
|
||||||
|
@REM under the License.
|
||||||
|
@REM ----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@REM ----------------------------------------------------------------------------
|
||||||
|
@REM Apache Maven Wrapper startup batch script, version 3.3.2
|
||||||
|
@REM
|
||||||
|
@REM Optional ENV vars
|
||||||
|
@REM MVNW_REPOURL - repo url base for downloading maven distribution
|
||||||
|
@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven
|
||||||
|
@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output
|
||||||
|
@REM ----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0)
|
||||||
|
@SET __MVNW_CMD__=
|
||||||
|
@SET __MVNW_ERROR__=
|
||||||
|
@SET __MVNW_PSMODULEP_SAVE=%PSModulePath%
|
||||||
|
@SET PSModulePath=
|
||||||
|
@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @(
|
||||||
|
IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B)
|
||||||
|
)
|
||||||
|
@SET PSModulePath=%__MVNW_PSMODULEP_SAVE%
|
||||||
|
@SET __MVNW_PSMODULEP_SAVE=
|
||||||
|
@SET __MVNW_ARG0_NAME__=
|
||||||
|
@SET MVNW_USERNAME=
|
||||||
|
@SET MVNW_PASSWORD=
|
||||||
|
@IF NOT "%__MVNW_CMD__%"=="" (%__MVNW_CMD__% %*)
|
||||||
|
@echo Cannot start maven from wrapper >&2 && exit /b 1
|
||||||
|
@GOTO :EOF
|
||||||
|
: end batch / begin powershell #>
|
||||||
|
|
||||||
|
$ErrorActionPreference = "Stop"
|
||||||
|
if ($env:MVNW_VERBOSE -eq "true") {
|
||||||
|
$VerbosePreference = "Continue"
|
||||||
|
}
|
||||||
|
|
||||||
|
# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties
|
||||||
|
$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl
|
||||||
|
if (!$distributionUrl) {
|
||||||
|
Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties"
|
||||||
|
}
|
||||||
|
|
||||||
|
switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) {
|
||||||
|
"maven-mvnd-*" {
|
||||||
|
$USE_MVND = $true
|
||||||
|
$distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip"
|
||||||
|
$MVN_CMD = "mvnd.cmd"
|
||||||
|
break
|
||||||
|
}
|
||||||
|
default {
|
||||||
|
$USE_MVND = $false
|
||||||
|
$MVN_CMD = $script -replace '^mvnw','mvn'
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# apply MVNW_REPOURL and calculate MAVEN_HOME
|
||||||
|
# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-<version>,maven-mvnd-<version>-<platform>}/<hash>
|
||||||
|
if ($env:MVNW_REPOURL) {
|
||||||
|
$MVNW_REPO_PATTERN = if ($USE_MVND) { "/org/apache/maven/" } else { "/maven/mvnd/" }
|
||||||
|
$distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace '^.*'+$MVNW_REPO_PATTERN,'')"
|
||||||
|
}
|
||||||
|
$distributionUrlName = $distributionUrl -replace '^.*/',''
|
||||||
|
$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$',''
|
||||||
|
$MAVEN_HOME_PARENT = "$HOME/.m2/wrapper/dists/$distributionUrlNameMain"
|
||||||
|
if ($env:MAVEN_USER_HOME) {
|
||||||
|
$MAVEN_HOME_PARENT = "$env:MAVEN_USER_HOME/wrapper/dists/$distributionUrlNameMain"
|
||||||
|
}
|
||||||
|
$MAVEN_HOME_NAME = ([System.Security.Cryptography.MD5]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join ''
|
||||||
|
$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME"
|
||||||
|
|
||||||
|
if (Test-Path -Path "$MAVEN_HOME" -PathType Container) {
|
||||||
|
Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME"
|
||||||
|
Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD"
|
||||||
|
exit $?
|
||||||
|
}
|
||||||
|
|
||||||
|
if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) {
|
||||||
|
Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl"
|
||||||
|
}
|
||||||
|
|
||||||
|
# prepare tmp dir
|
||||||
|
$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile
|
||||||
|
$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir"
|
||||||
|
$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null
|
||||||
|
trap {
|
||||||
|
if ($TMP_DOWNLOAD_DIR.Exists) {
|
||||||
|
try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null }
|
||||||
|
catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null
|
||||||
|
|
||||||
|
# Download and Install Apache Maven
|
||||||
|
Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..."
|
||||||
|
Write-Verbose "Downloading from: $distributionUrl"
|
||||||
|
Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName"
|
||||||
|
|
||||||
|
$webclient = New-Object System.Net.WebClient
|
||||||
|
if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) {
|
||||||
|
$webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD)
|
||||||
|
}
|
||||||
|
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
|
||||||
|
$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null
|
||||||
|
|
||||||
|
# If specified, validate the SHA-256 sum of the Maven distribution zip file
|
||||||
|
$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum
|
||||||
|
if ($distributionSha256Sum) {
|
||||||
|
if ($USE_MVND) {
|
||||||
|
Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties."
|
||||||
|
}
|
||||||
|
Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash
|
||||||
|
if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) {
|
||||||
|
Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# unzip and move
|
||||||
|
Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null
|
||||||
|
Rename-Item -Path "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" -NewName $MAVEN_HOME_NAME | Out-Null
|
||||||
|
try {
|
||||||
|
Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null
|
||||||
|
} catch {
|
||||||
|
if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) {
|
||||||
|
Write-Error "fail to move MAVEN_HOME"
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null }
|
||||||
|
catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" }
|
||||||
|
}
|
||||||
|
|
||||||
|
Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD"
|
||||||
111
pom.xml
Normal file
111
pom.xml
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
|
||||||
|
https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
|
<groupId>tr.com.erato</groupId>
|
||||||
|
<artifactId>spring-boot-starter-rate-limit</artifactId>
|
||||||
|
<version>1.0.0</version>
|
||||||
|
<packaging>jar</packaging>
|
||||||
|
|
||||||
|
<name>Erato Soft Rate Limit Spring Boot Starter</name>
|
||||||
|
<description>Redis-based rate limiting starter for Spring Boot microservices</description>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<java.version>17</java.version>
|
||||||
|
<maven.compiler.source>17</maven.compiler.source>
|
||||||
|
<maven.compiler.target>17</maven.compiler.target>
|
||||||
|
<spring-boot.version>3.1.5</spring-boot.version>
|
||||||
|
</properties>
|
||||||
|
|
||||||
|
<dependencyManagement>
|
||||||
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-dependencies</artifactId>
|
||||||
|
<version>${spring-boot.version}</version>
|
||||||
|
<type>pom</type>
|
||||||
|
<scope>import</scope>
|
||||||
|
</dependency>
|
||||||
|
</dependencies>
|
||||||
|
</dependencyManagement>
|
||||||
|
|
||||||
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter</artifactId>
|
||||||
|
</dependency>
|
||||||
|
<!-- Spring Boot Configuration Processor -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-configuration-processor</artifactId>
|
||||||
|
<optional>true</optional>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Spring Web -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-web</artifactId>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Spring Data Redis -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-data-redis</artifactId>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Spring Security (optional) -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-security</artifactId>
|
||||||
|
<optional>true</optional>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Lombok -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.projectlombok</groupId>
|
||||||
|
<artifactId>lombok</artifactId>
|
||||||
|
<optional>true</optional>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Jackson -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.fasterxml.jackson.core</groupId>
|
||||||
|
<artifactId>jackson-databind</artifactId>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-test</artifactId>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
</dependencies>
|
||||||
|
<build>
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
|
<artifactId>maven-compiler-plugin</artifactId>
|
||||||
|
<version>3.11.0</version>
|
||||||
|
<configuration>
|
||||||
|
<source>17</source>
|
||||||
|
<target>17</target>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
|
<artifactId>maven-source-plugin</artifactId>
|
||||||
|
<version>3.3.0</version>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>attach-sources</id>
|
||||||
|
<goals>
|
||||||
|
<goal>jar</goal>
|
||||||
|
</goals>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</build>
|
||||||
|
</project>
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
package tr.com.erato.RateLimit;
|
||||||
|
|
||||||
|
import org.springframework.boot.SpringApplication;
|
||||||
|
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||||
|
|
||||||
|
@SpringBootApplication
|
||||||
|
public class SpringBootStarterRateLimitApplication {
|
||||||
|
|
||||||
|
public static void main(String[] args) {
|
||||||
|
SpringApplication.run(SpringBootStarterRateLimitApplication.class, args);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
package tr.com.erato.RateLimit.annotation;
|
||||||
|
|
||||||
|
import java.lang.annotation.ElementType;
|
||||||
|
import java.lang.annotation.Retention;
|
||||||
|
import java.lang.annotation.RetentionPolicy;
|
||||||
|
import java.lang.annotation.Target;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enable rate limiting for a Spring Boot application
|
||||||
|
*/
|
||||||
|
@Target(ElementType.TYPE)
|
||||||
|
@Retention(RetentionPolicy.RUNTIME)
|
||||||
|
public @interface EnableRateLimit {
|
||||||
|
}
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
package tr.com.erato.RateLimit.annotation;
|
||||||
|
|
||||||
|
import java.lang.annotation.ElementType;
|
||||||
|
import java.lang.annotation.Retention;
|
||||||
|
import java.lang.annotation.RetentionPolicy;
|
||||||
|
import java.lang.annotation.Target;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rate limiting annotation for REST endpoints
|
||||||
|
* <p>
|
||||||
|
* Example usage:
|
||||||
|
* <p>
|
||||||
|
* @RateLimit(limit = 100, window = TimeWindow.HOUR)
|
||||||
|
* <p>
|
||||||
|
* @RateLimit(limit = 10, window = TimeWindow.MINUTE, type = RateLimitType.IP)
|
||||||
|
*/
|
||||||
|
@Target({ElementType.METHOD, ElementType.TYPE})
|
||||||
|
@Retention(RetentionPolicy.RUNTIME)
|
||||||
|
public @interface RateLimit {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Maximum number of requests allowed in the time window
|
||||||
|
*/
|
||||||
|
int limit() default -1; // -1 means use default from properties
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Time window for rate limiting
|
||||||
|
*/
|
||||||
|
TimeWindow window() default TimeWindow.DEFAULT;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Type of rate limiting (IP-based or global)
|
||||||
|
*/
|
||||||
|
RateLimitType type() default RateLimitType.IP;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Custom key prefix (optional)
|
||||||
|
* Useful for grouping different endpoints under same limit
|
||||||
|
*/
|
||||||
|
String keyPrefix() default "";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Error message when rate limit is exceeded
|
||||||
|
*/
|
||||||
|
String message() default "";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Use a preset configuration
|
||||||
|
*/
|
||||||
|
String preset() default "";
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
package tr.com.erato.RateLimit.annotation;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rate limit types
|
||||||
|
*/
|
||||||
|
public enum RateLimitType {
|
||||||
|
/**
|
||||||
|
* Rate limit per IP address
|
||||||
|
*/
|
||||||
|
IP,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Global rate limit for all requests
|
||||||
|
*/
|
||||||
|
GLOBAL,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rate limit per authenticated user
|
||||||
|
*/
|
||||||
|
USER
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
package tr.com.erato.RateLimit.annotation;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Time window options for rate limiting
|
||||||
|
*/
|
||||||
|
public enum TimeWindow {
|
||||||
|
DEFAULT(0), // Use default from properties
|
||||||
|
SECOND(1),
|
||||||
|
MINUTE(60),
|
||||||
|
HOUR(3600),
|
||||||
|
DAY(86400);
|
||||||
|
|
||||||
|
private final int seconds;
|
||||||
|
|
||||||
|
TimeWindow(int seconds) {
|
||||||
|
this.seconds = seconds;
|
||||||
|
}
|
||||||
|
|
||||||
|
public int getSeconds() {
|
||||||
|
return seconds;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,114 @@
|
|||||||
|
package tr.com.erato.RateLimit.config;
|
||||||
|
|
||||||
|
import tr.com.erato.RateLimit.annotation.EnableRateLimit;
|
||||||
|
import tr.com.erato.RateLimit.interceptor.RateLimitInterceptor;
|
||||||
|
import tr.com.erato.RateLimit.service.RateLimitAdminService;
|
||||||
|
import tr.com.erato.RateLimit.service.RateLimitService;
|
||||||
|
import tr.com.erato.RateLimit.controller.RateLimitAdminController;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
||||||
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||||
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||||
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||||
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
|
||||||
|
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||||
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.context.annotation.ComponentScan;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
import org.springframework.data.redis.core.RedisTemplate;
|
||||||
|
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
|
||||||
|
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Auto-configuration for rate limiting
|
||||||
|
*/
|
||||||
|
@Slf4j
|
||||||
|
@AutoConfiguration
|
||||||
|
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
|
||||||
|
@ConditionalOnClass({RedisTemplate.class})
|
||||||
|
@ConditionalOnProperty(
|
||||||
|
prefix = "erato.rate-limit",
|
||||||
|
name = "enabled",
|
||||||
|
havingValue = "true",
|
||||||
|
matchIfMissing = true
|
||||||
|
)
|
||||||
|
@EnableConfigurationProperties(RateLimitProperties.class)
|
||||||
|
public class RateLimitAutoConfiguration {
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
@ConditionalOnMissingBean
|
||||||
|
public RateLimitService rateLimitService(
|
||||||
|
RedisTemplate<String, Object> redisTemplate,
|
||||||
|
RateLimitProperties properties) {
|
||||||
|
log.info("Configuring RateLimitService with prefix: {}", properties.getRedisKeyPrefix());
|
||||||
|
return new RateLimitService(redisTemplate, properties);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
@ConditionalOnMissingBean
|
||||||
|
public RateLimitInterceptor rateLimitInterceptor(
|
||||||
|
RateLimitService rateLimitService,
|
||||||
|
RateLimitProperties properties) {
|
||||||
|
log.info("Configuring RateLimitInterceptor");
|
||||||
|
return new RateLimitInterceptor(rateLimitService, properties);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
@ConditionalOnMissingBean
|
||||||
|
@ConditionalOnProperty(
|
||||||
|
prefix = "erato.rate-limit",
|
||||||
|
name = "admin-enabled",
|
||||||
|
havingValue = "true",
|
||||||
|
matchIfMissing = true
|
||||||
|
)
|
||||||
|
public RateLimitAdminService rateLimitAdminService(
|
||||||
|
RedisTemplate<String, Object> redisTemplate,
|
||||||
|
RateLimitProperties properties) {
|
||||||
|
log.info("Configuring RateLimitAdminService");
|
||||||
|
return new RateLimitAdminService(redisTemplate, properties);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
@ConditionalOnMissingBean
|
||||||
|
@ConditionalOnProperty(
|
||||||
|
prefix = "erato.rate-limit",
|
||||||
|
name = "admin-enabled",
|
||||||
|
havingValue = "true",
|
||||||
|
matchIfMissing = true
|
||||||
|
)
|
||||||
|
public RateLimitAdminController rateLimitAdminController(
|
||||||
|
RateLimitAdminService adminService) {
|
||||||
|
log.info("Configuring RateLimitAdminController");
|
||||||
|
return new RateLimitAdminController(adminService);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Configuration
|
||||||
|
@ConditionalOnProperty(
|
||||||
|
prefix = "erato.rate-limit",
|
||||||
|
name = "enabled",
|
||||||
|
havingValue = "true",
|
||||||
|
matchIfMissing = true
|
||||||
|
)
|
||||||
|
public static class RateLimitWebMvcConfiguration implements WebMvcConfigurer {
|
||||||
|
|
||||||
|
private final RateLimitInterceptor rateLimitInterceptor;
|
||||||
|
private final RateLimitProperties properties;
|
||||||
|
|
||||||
|
public RateLimitWebMvcConfiguration(
|
||||||
|
RateLimitInterceptor rateLimitInterceptor,
|
||||||
|
RateLimitProperties properties) {
|
||||||
|
this.rateLimitInterceptor = rateLimitInterceptor;
|
||||||
|
this.properties = properties;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void addInterceptors(InterceptorRegistry registry) {
|
||||||
|
log.info("Registering RateLimitInterceptor for patterns: {}",
|
||||||
|
String.join(", ", properties.getIncludePatterns()));
|
||||||
|
|
||||||
|
registry.addInterceptor(rateLimitInterceptor)
|
||||||
|
.addPathPatterns(properties.getIncludePatterns())
|
||||||
|
.excludePathPatterns(properties.getExcludePatterns());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
package tr.com.erato.RateLimit.config;
|
||||||
|
|
||||||
|
import lombok.Data;
|
||||||
|
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||||
|
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configuration properties for rate limiting
|
||||||
|
* <p>
|
||||||
|
* Example application.properties:
|
||||||
|
* erato.rate-limit.enabled=true
|
||||||
|
* erato.rate-limit.redis-key-prefix=rate_limit:
|
||||||
|
* erato.rate-limit.include-headers=true
|
||||||
|
* erato.rate-limit.default-limit=60
|
||||||
|
* erato.rate-limit.default-window=MINUTE
|
||||||
|
*/
|
||||||
|
@Data
|
||||||
|
@ConfigurationProperties(prefix = "erato.rate-limit")
|
||||||
|
public class RateLimitProperties {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enable/disable rate limiting globally
|
||||||
|
*/
|
||||||
|
private boolean enabled = true;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Redis key prefix for rate limit keys
|
||||||
|
*/
|
||||||
|
private String redisKeyPrefix = "rate_limit:";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Include rate limit headers in response
|
||||||
|
*/
|
||||||
|
private boolean includeHeaders = true;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Default rate limit when not specified
|
||||||
|
*/
|
||||||
|
private int defaultLimit = 60;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Default time window when not specified
|
||||||
|
*/
|
||||||
|
private String defaultWindow = "MINUTE";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Path patterns to include (default: all)
|
||||||
|
*/
|
||||||
|
private String[] includePatterns = {"/api/**"};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Path patterns to exclude
|
||||||
|
*/
|
||||||
|
private String[] excludePatterns = {"/api/health/**", "/actuator/**"};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enable admin endpoints
|
||||||
|
*/
|
||||||
|
private boolean adminEnabled = true;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Admin endpoint base path
|
||||||
|
*/
|
||||||
|
private String adminBasePath = "/api/admin/rate-limits";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Custom error response settings
|
||||||
|
*/
|
||||||
|
private ErrorResponse errorResponse = new ErrorResponse();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rate limit presets for common scenarios
|
||||||
|
*/
|
||||||
|
private Map<String, PresetConfig> presets = new HashMap<>();
|
||||||
|
|
||||||
|
@Data
|
||||||
|
public static class ErrorResponse {
|
||||||
|
private String message = "Rate limit exceeded";
|
||||||
|
private boolean includeRetryAfter = true;
|
||||||
|
private String contentType = "application/json";
|
||||||
|
}
|
||||||
|
|
||||||
|
@Data
|
||||||
|
public static class PresetConfig {
|
||||||
|
private int limit;
|
||||||
|
private String window;
|
||||||
|
private String type;
|
||||||
|
private String message;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
package tr.com.erato.RateLimit.controller;
|
||||||
|
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||||
|
import org.springframework.http.ResponseEntity;
|
||||||
|
import org.springframework.security.access.prepost.PreAuthorize;
|
||||||
|
import org.springframework.web.bind.annotation.*;
|
||||||
|
import tr.com.erato.RateLimit.service.RateLimitAdminService;
|
||||||
|
import tr.com.erato.RateLimit.service.RateLimitAdminService.RateLimitInfo;
|
||||||
|
import tr.com.erato.RateLimit.service.RateLimitAdminService.RateLimitStats;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Admin endpoints for managing rate limits
|
||||||
|
*/
|
||||||
|
@RestController
|
||||||
|
@RequestMapping("${erato.rate-limit.admin-base-path:/api/admin/rate-limits}")
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
@ConditionalOnProperty(
|
||||||
|
prefix = "erato.rate-limit",
|
||||||
|
name = "admin-enabled",
|
||||||
|
havingValue = "true",
|
||||||
|
matchIfMissing = true
|
||||||
|
)
|
||||||
|
@PreAuthorize("hasRole('ADMIN')")
|
||||||
|
public class RateLimitAdminController {
|
||||||
|
|
||||||
|
private final RateLimitAdminService rateLimitAdminService;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all active rate limits
|
||||||
|
*/
|
||||||
|
@GetMapping
|
||||||
|
public ResponseEntity<Map<String, RateLimitInfo>> getAllRateLimits() {
|
||||||
|
return ResponseEntity.ok(rateLimitAdminService.getAllRateLimits());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get rate limit statistics
|
||||||
|
*/
|
||||||
|
@GetMapping("/stats")
|
||||||
|
public ResponseEntity<RateLimitStats> getStatistics() {
|
||||||
|
return ResponseEntity.ok(rateLimitAdminService.getStatistics());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get top rate limited keys
|
||||||
|
*/
|
||||||
|
@GetMapping("/top")
|
||||||
|
public ResponseEntity<List<RateLimitInfo>> getTopRateLimitedKeys(
|
||||||
|
@RequestParam(defaultValue = "10") int limit) {
|
||||||
|
return ResponseEntity.ok(rateLimitAdminService.getTopRateLimitedKeys(limit));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check specific rate limit
|
||||||
|
*/
|
||||||
|
@GetMapping("/check/{key}")
|
||||||
|
public ResponseEntity<RateLimitInfo> checkRateLimit(@PathVariable String key) {
|
||||||
|
Optional<RateLimitInfo> info = rateLimitAdminService.checkRateLimit(key);
|
||||||
|
return info.map(ResponseEntity::ok)
|
||||||
|
.orElse(ResponseEntity.notFound().build());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reset a specific rate limit
|
||||||
|
*/
|
||||||
|
@DeleteMapping("/{key}")
|
||||||
|
public ResponseEntity<Map<String, Object>> resetRateLimit(@PathVariable String key) {
|
||||||
|
boolean success = rateLimitAdminService.resetRateLimit(key);
|
||||||
|
return ResponseEntity.ok(Map.of(
|
||||||
|
"success", success,
|
||||||
|
"key", key,
|
||||||
|
"message", success ? "Rate limit reset successfully" : "Rate limit key not found"
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reset all rate limits
|
||||||
|
*/
|
||||||
|
@DeleteMapping
|
||||||
|
public ResponseEntity<Map<String, Object>> resetAllRateLimits() {
|
||||||
|
int count = rateLimitAdminService.resetAllRateLimits();
|
||||||
|
return ResponseEntity.ok(Map.of(
|
||||||
|
"success", true,
|
||||||
|
"count", count,
|
||||||
|
"message", String.format("Reset %d rate limit keys", count)
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Health check endpoint (not rate limited)
|
||||||
|
*/
|
||||||
|
@GetMapping("/health")
|
||||||
|
@PreAuthorize("permitAll()")
|
||||||
|
public ResponseEntity<Map<String, String>> health() {
|
||||||
|
return ResponseEntity.ok(Map.of(
|
||||||
|
"status", "UP",
|
||||||
|
"service", "RateLimitAdmin"
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
package tr.com.erato.RateLimit.interceptor;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import tr.com.erato.RateLimit.annotation.RateLimit;
|
||||||
|
import tr.com.erato.RateLimit.config.RateLimitProperties;
|
||||||
|
import tr.com.erato.RateLimit.model.RateLimitResult;
|
||||||
|
import tr.com.erato.RateLimit.service.RateLimitService;
|
||||||
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
|
import jakarta.servlet.http.HttpServletResponse;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.http.HttpStatus;
|
||||||
|
import org.springframework.web.method.HandlerMethod;
|
||||||
|
import org.springframework.web.servlet.HandlerInterceptor;
|
||||||
|
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interceptor for rate limiting
|
||||||
|
*/
|
||||||
|
@Slf4j
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class RateLimitInterceptor implements HandlerInterceptor {
|
||||||
|
|
||||||
|
private final RateLimitService rateLimitService;
|
||||||
|
private final RateLimitProperties properties;
|
||||||
|
private final ObjectMapper objectMapper = new ObjectMapper();
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
|
||||||
|
if (!(handler instanceof HandlerMethod)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
HandlerMethod handlerMethod = (HandlerMethod) handler;
|
||||||
|
RateLimit rateLimit = getRateLimit(handlerMethod);
|
||||||
|
|
||||||
|
if (rateLimit == null) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
String handlerName = handlerMethod.getBeanType().getSimpleName() + "." + handlerMethod.getMethod().getName();
|
||||||
|
RateLimitResult result = rateLimitService.checkRateLimit(request, handlerName, rateLimit);
|
||||||
|
|
||||||
|
// Add headers if enabled
|
||||||
|
if (properties.isIncludeHeaders()) {
|
||||||
|
response.setHeader("X-RateLimit-Limit", String.valueOf(result.getLimit()));
|
||||||
|
response.setHeader("X-RateLimit-Remaining", String.valueOf(result.getRemaining()));
|
||||||
|
response.setHeader("X-RateLimit-Reset", String.valueOf(result.getResetTime()));
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!result.isAllowed()) {
|
||||||
|
handleRateLimitExceeded(response, result);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get rate limit annotation from method or class
|
||||||
|
*/
|
||||||
|
private RateLimit getRateLimit(HandlerMethod handlerMethod) {
|
||||||
|
RateLimit rateLimit = handlerMethod.getMethodAnnotation(RateLimit.class);
|
||||||
|
if (rateLimit == null) {
|
||||||
|
rateLimit = handlerMethod.getBeanType().getAnnotation(RateLimit.class);
|
||||||
|
}
|
||||||
|
return rateLimit;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle rate limit exceeded response
|
||||||
|
*/
|
||||||
|
private void handleRateLimitExceeded(HttpServletResponse response, RateLimitResult result) throws Exception {
|
||||||
|
response.setStatus(HttpStatus.TOO_MANY_REQUESTS.value());
|
||||||
|
response.setContentType(properties.getErrorResponse().getContentType());
|
||||||
|
|
||||||
|
if (properties.getErrorResponse().isIncludeRetryAfter()) {
|
||||||
|
response.setHeader("Retry-After", String.valueOf(result.getRetryAfter()));
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, Object> errorResponse = new HashMap<>();
|
||||||
|
errorResponse.put("error", "RATE_LIMIT_EXCEEDED");
|
||||||
|
errorResponse.put("message", result.getMessage());
|
||||||
|
errorResponse.put("limit", result.getLimit());
|
||||||
|
errorResponse.put("windowSeconds", getWindowSeconds(result));
|
||||||
|
|
||||||
|
if (properties.getErrorResponse().isIncludeRetryAfter()) {
|
||||||
|
errorResponse.put("retryAfter", result.getRetryAfter());
|
||||||
|
}
|
||||||
|
|
||||||
|
String jsonResponse = objectMapper.writeValueAsString(errorResponse);
|
||||||
|
response.getWriter().write(jsonResponse);
|
||||||
|
}
|
||||||
|
|
||||||
|
private long getWindowSeconds(RateLimitResult result) {
|
||||||
|
// Calculate window seconds from reset time if available
|
||||||
|
if (result.getResetTime() > 0) {
|
||||||
|
long currentTime = System.currentTimeMillis() / 1000;
|
||||||
|
return Math.max(result.getResetTime() - currentTime + result.getRetryAfter(), result.getRetryAfter());
|
||||||
|
}
|
||||||
|
return 3600; // Default 1 hour
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
package tr.com.erato.RateLimit.model;
|
||||||
|
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
import lombok.Data;
|
||||||
|
import lombok.NoArgsConstructor;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rate limit check result
|
||||||
|
*/
|
||||||
|
@Data
|
||||||
|
@NoArgsConstructor
|
||||||
|
@AllArgsConstructor
|
||||||
|
public class RateLimitResult {
|
||||||
|
|
||||||
|
private boolean allowed;
|
||||||
|
private int limit;
|
||||||
|
private int remaining;
|
||||||
|
private long resetTime;
|
||||||
|
private long retryAfter;
|
||||||
|
private String message;
|
||||||
|
|
||||||
|
public static RateLimitResult allowed() {
|
||||||
|
return new RateLimitResult(true, 0, 0, 0, 0, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static RateLimitResult allowed(int limit, int remaining, long resetTime) {
|
||||||
|
return new RateLimitResult(true, limit, remaining, resetTime, 0, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static RateLimitResult exceeded(int limit, int remaining, long resetTime, long retryAfter, String message) {
|
||||||
|
return new RateLimitResult(false, limit, remaining, resetTime, retryAfter, message);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,185 @@
|
|||||||
|
package tr.com.erato.RateLimit.service;
|
||||||
|
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.data.redis.core.RedisTemplate;
|
||||||
|
import org.springframework.stereotype.Service;
|
||||||
|
import tr.com.erato.RateLimit.config.RateLimitProperties;
|
||||||
|
|
||||||
|
import java.util.*;
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Admin service for managing rate limits
|
||||||
|
*/
|
||||||
|
@Slf4j
|
||||||
|
@Service
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class RateLimitAdminService {
|
||||||
|
|
||||||
|
private final RedisTemplate<String, Object> redisTemplate;
|
||||||
|
private final RateLimitProperties properties;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all active rate limit keys with their current counts and TTLs
|
||||||
|
*/
|
||||||
|
public Map<String, RateLimitInfo> getAllRateLimits() {
|
||||||
|
Map<String, RateLimitInfo> rateLimits = new HashMap<>();
|
||||||
|
String pattern = properties.getRedisKeyPrefix() + "*";
|
||||||
|
|
||||||
|
Set<String> keys = redisTemplate.keys(pattern);
|
||||||
|
if (keys != null) {
|
||||||
|
for (String key : keys) {
|
||||||
|
Object value = redisTemplate.opsForValue().get(key);
|
||||||
|
Long ttl = redisTemplate.getExpire(key, TimeUnit.SECONDS);
|
||||||
|
|
||||||
|
if (value != null && ttl != null && ttl > 0) {
|
||||||
|
String cleanKey = key.replace(properties.getRedisKeyPrefix(), "");
|
||||||
|
rateLimits.put(cleanKey, new RateLimitInfo(
|
||||||
|
cleanKey,
|
||||||
|
Long.parseLong(value.toString()),
|
||||||
|
ttl
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return rateLimits;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reset rate limit for a specific key
|
||||||
|
*/
|
||||||
|
public boolean resetRateLimit(String key) {
|
||||||
|
String fullKey = key.startsWith(properties.getRedisKeyPrefix())
|
||||||
|
? key
|
||||||
|
: properties.getRedisKeyPrefix() + key;
|
||||||
|
|
||||||
|
Boolean deleted = redisTemplate.delete(fullKey);
|
||||||
|
log.info("Reset rate limit for key: {}, success: {}", fullKey, deleted);
|
||||||
|
return Boolean.TRUE.equals(deleted);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reset all rate limits
|
||||||
|
*/
|
||||||
|
public int resetAllRateLimits() {
|
||||||
|
String pattern = properties.getRedisKeyPrefix() + "*";
|
||||||
|
Set<String> keys = redisTemplate.keys(pattern);
|
||||||
|
|
||||||
|
if (keys != null && !keys.isEmpty()) {
|
||||||
|
Long deleted = redisTemplate.delete(keys);
|
||||||
|
log.info("Reset {} rate limit keys", deleted);
|
||||||
|
return deleted != null ? deleted.intValue() : 0;
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get rate limit statistics
|
||||||
|
*/
|
||||||
|
public RateLimitStats getStatistics() {
|
||||||
|
String pattern = properties.getRedisKeyPrefix() + "*";
|
||||||
|
Set<String> keys = redisTemplate.keys(pattern);
|
||||||
|
|
||||||
|
if (keys == null || keys.isEmpty()) {
|
||||||
|
return new RateLimitStats(0, Collections.emptyMap(), Collections.emptyMap());
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, Integer> typeCount = new HashMap<>();
|
||||||
|
Map<String, Integer> windowCount = new HashMap<>();
|
||||||
|
|
||||||
|
for (String key : keys) {
|
||||||
|
String cleanKey = key.replace(properties.getRedisKeyPrefix(), "");
|
||||||
|
String[] parts = cleanKey.split(":");
|
||||||
|
|
||||||
|
// Count by type (IP, USER, GLOBAL)
|
||||||
|
if (parts.length > 1) {
|
||||||
|
String type = identifyType(parts);
|
||||||
|
typeCount.merge(type, 1, Integer::sum);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Count by window
|
||||||
|
if (parts.length > 0) {
|
||||||
|
String window = parts[parts.length - 1];
|
||||||
|
if (isTimeWindow(window)) {
|
||||||
|
windowCount.merge(window, 1, Integer::sum);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return new RateLimitStats(keys.size(), typeCount, windowCount);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get top rate limited keys
|
||||||
|
*/
|
||||||
|
public List<RateLimitInfo> getTopRateLimitedKeys(int limit) {
|
||||||
|
Map<String, RateLimitInfo> allLimits = getAllRateLimits();
|
||||||
|
|
||||||
|
return allLimits.values().stream()
|
||||||
|
.sorted((a, b) -> Long.compare(b.count(), a.count()))
|
||||||
|
.limit(limit)
|
||||||
|
.toList();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if a specific key is rate limited
|
||||||
|
*/
|
||||||
|
public Optional<RateLimitInfo> checkRateLimit(String key) {
|
||||||
|
String fullKey = key.startsWith(properties.getRedisKeyPrefix())
|
||||||
|
? key
|
||||||
|
: properties.getRedisKeyPrefix() + key;
|
||||||
|
|
||||||
|
Object value = redisTemplate.opsForValue().get(fullKey);
|
||||||
|
Long ttl = redisTemplate.getExpire(fullKey, TimeUnit.SECONDS);
|
||||||
|
|
||||||
|
if (value != null && ttl != null && ttl > 0) {
|
||||||
|
String cleanKey = key.replace(properties.getRedisKeyPrefix(), "");
|
||||||
|
return Optional.of(new RateLimitInfo(
|
||||||
|
cleanKey,
|
||||||
|
Long.parseLong(value.toString()),
|
||||||
|
ttl
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper methods
|
||||||
|
private String identifyType(String[] parts) {
|
||||||
|
for (String part : parts) {
|
||||||
|
if ("ip".equals(part)) return "IP";
|
||||||
|
if ("user".equals(part)) return "USER";
|
||||||
|
if ("global".equals(part)) return "GLOBAL";
|
||||||
|
}
|
||||||
|
return "UNKNOWN";
|
||||||
|
}
|
||||||
|
|
||||||
|
private boolean isTimeWindow(String value) {
|
||||||
|
return Set.of("SECOND", "MINUTE", "HOUR", "DAY").contains(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
// DTOs
|
||||||
|
public record RateLimitInfo(String key, long count, long ttlSeconds) {
|
||||||
|
public long getRemainingSeconds() {
|
||||||
|
return ttlSeconds;
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getFormattedTTL() {
|
||||||
|
if (ttlSeconds < 60) {
|
||||||
|
return ttlSeconds + " seconds";
|
||||||
|
} else if (ttlSeconds < 3600) {
|
||||||
|
return (ttlSeconds / 60) + " minutes";
|
||||||
|
} else {
|
||||||
|
return (ttlSeconds / 3600) + " hours";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public record RateLimitStats(
|
||||||
|
int totalKeys,
|
||||||
|
Map<String, Integer> countByType,
|
||||||
|
Map<String, Integer> countByWindow
|
||||||
|
) {}
|
||||||
|
}
|
||||||
@@ -0,0 +1,200 @@
|
|||||||
|
package tr.com.erato.RateLimit.service;
|
||||||
|
|
||||||
|
import tr.com.erato.RateLimit.annotation.RateLimit;
|
||||||
|
import tr.com.erato.RateLimit.annotation.RateLimitType;
|
||||||
|
import tr.com.erato.RateLimit.annotation.TimeWindow;
|
||||||
|
import tr.com.erato.RateLimit.config.RateLimitProperties;
|
||||||
|
import tr.com.erato.RateLimit.model.RateLimitResult;
|
||||||
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.data.redis.core.RedisTemplate;
|
||||||
|
import org.springframework.security.core.Authentication;
|
||||||
|
import org.springframework.security.core.context.SecurityContextHolder;
|
||||||
|
import org.springframework.util.StringUtils;
|
||||||
|
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Core rate limiting service
|
||||||
|
*/
|
||||||
|
@Slf4j
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
public class RateLimitService {
|
||||||
|
|
||||||
|
private final RedisTemplate<String, Object> redisTemplate;
|
||||||
|
private final RateLimitProperties properties;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check and apply rate limit
|
||||||
|
*/
|
||||||
|
public RateLimitResult checkRateLimit(HttpServletRequest request, String handlerName, RateLimit rateLimit) {
|
||||||
|
if (!properties.isEnabled()) {
|
||||||
|
return RateLimitResult.allowed();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get configuration from annotation or defaults
|
||||||
|
int limit = getLimit(rateLimit);
|
||||||
|
TimeWindow window = getTimeWindow(rateLimit);
|
||||||
|
String key = buildKey(request, handlerName, rateLimit);
|
||||||
|
|
||||||
|
// Increment counter
|
||||||
|
Long currentCount = redisTemplate.opsForValue().increment(key);
|
||||||
|
if (currentCount == null) {
|
||||||
|
currentCount = 1L;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set expiration on first request
|
||||||
|
if (currentCount == 1) {
|
||||||
|
redisTemplate.expire(key, window.getSeconds(), TimeUnit.SECONDS);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get TTL
|
||||||
|
Long ttl = redisTemplate.getExpire(key, TimeUnit.SECONDS);
|
||||||
|
if (ttl == null || ttl == -2) {
|
||||||
|
// Key expired, reset
|
||||||
|
redisTemplate.delete(key);
|
||||||
|
return RateLimitResult.allowed();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Calculate reset time
|
||||||
|
long resetTime = System.currentTimeMillis() / 1000 + ttl;
|
||||||
|
|
||||||
|
if (currentCount > limit) {
|
||||||
|
String message = getMessage(rateLimit);
|
||||||
|
log.debug("Rate limit exceeded for key: {}", key);
|
||||||
|
return RateLimitResult.exceeded(limit, 0, resetTime, ttl, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
return RateLimitResult.allowed(limit, Math.max(0, limit - currentCount.intValue()), resetTime);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build Redis key for rate limiting
|
||||||
|
*/
|
||||||
|
private String buildKey(HttpServletRequest request, String handlerName, RateLimit rateLimit) {
|
||||||
|
StringBuilder keyBuilder = new StringBuilder(properties.getRedisKeyPrefix());
|
||||||
|
|
||||||
|
// Add custom prefix or handler name
|
||||||
|
if (StringUtils.hasText(rateLimit.keyPrefix())) {
|
||||||
|
keyBuilder.append(rateLimit.keyPrefix());
|
||||||
|
} else {
|
||||||
|
keyBuilder.append(handlerName);
|
||||||
|
}
|
||||||
|
keyBuilder.append(":");
|
||||||
|
|
||||||
|
// Add identifier based on type
|
||||||
|
switch (rateLimit.type()) {
|
||||||
|
case IP:
|
||||||
|
keyBuilder.append("ip:").append(getClientIp(request));
|
||||||
|
break;
|
||||||
|
case USER:
|
||||||
|
keyBuilder.append("user:").append(getCurrentUserId());
|
||||||
|
break;
|
||||||
|
case GLOBAL:
|
||||||
|
keyBuilder.append("global");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add time window
|
||||||
|
keyBuilder.append(":").append(getTimeWindow(rateLimit).name());
|
||||||
|
|
||||||
|
return keyBuilder.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get client IP address
|
||||||
|
*/
|
||||||
|
private String getClientIp(HttpServletRequest request) {
|
||||||
|
// Check for proxied requests
|
||||||
|
String[] headers = {"X-Forwarded-For", "X-Real-IP", "Proxy-Client-IP",
|
||||||
|
"WL-Proxy-Client-IP", "HTTP_CLIENT_IP", "HTTP_X_FORWARDED_FOR"};
|
||||||
|
|
||||||
|
for (String header : headers) {
|
||||||
|
String ip = request.getHeader(header);
|
||||||
|
if (StringUtils.hasText(ip) && !"unknown".equalsIgnoreCase(ip)) {
|
||||||
|
// Take the first IP if multiple are present
|
||||||
|
return ip.split(",")[0].trim();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return request.getRemoteAddr();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get current user ID
|
||||||
|
*/
|
||||||
|
private String getCurrentUserId() {
|
||||||
|
try {
|
||||||
|
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
|
||||||
|
if (authentication != null && authentication.isAuthenticated()
|
||||||
|
&& !"anonymousUser".equals(authentication.getPrincipal())) {
|
||||||
|
return authentication.getName();
|
||||||
|
}
|
||||||
|
} catch (Exception e) {
|
||||||
|
log.debug("Could not get user ID from security context", e);
|
||||||
|
}
|
||||||
|
return "anonymous";
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get rate limit from annotation or preset
|
||||||
|
*/
|
||||||
|
private int getLimit(RateLimit rateLimit) {
|
||||||
|
// Check for preset first
|
||||||
|
if (StringUtils.hasText(rateLimit.preset())) {
|
||||||
|
RateLimitProperties.PresetConfig preset = properties.getPresets().get(rateLimit.preset());
|
||||||
|
if (preset != null && preset.getLimit() > 0) {
|
||||||
|
return preset.getLimit();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use annotation value or default
|
||||||
|
return rateLimit.limit() > 0 ? rateLimit.limit() : properties.getDefaultLimit();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get time window from annotation or preset
|
||||||
|
*/
|
||||||
|
private TimeWindow getTimeWindow(RateLimit rateLimit) {
|
||||||
|
// Check for preset first
|
||||||
|
if (StringUtils.hasText(rateLimit.preset())) {
|
||||||
|
RateLimitProperties.PresetConfig preset = properties.getPresets().get(rateLimit.preset());
|
||||||
|
if (preset != null && StringUtils.hasText(preset.getWindow())) {
|
||||||
|
try {
|
||||||
|
return TimeWindow.valueOf(preset.getWindow());
|
||||||
|
} catch (IllegalArgumentException ignored) {
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use annotation value or default
|
||||||
|
if (rateLimit.window() != TimeWindow.DEFAULT) {
|
||||||
|
return rateLimit.window();
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return TimeWindow.valueOf(properties.getDefaultWindow());
|
||||||
|
} catch (IllegalArgumentException e) {
|
||||||
|
return TimeWindow.MINUTE;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get error message
|
||||||
|
*/
|
||||||
|
private String getMessage(RateLimit rateLimit) {
|
||||||
|
// Check for preset first
|
||||||
|
if (StringUtils.hasText(rateLimit.preset())) {
|
||||||
|
RateLimitProperties.PresetConfig preset = properties.getPresets().get(rateLimit.preset());
|
||||||
|
if (preset != null && StringUtils.hasText(preset.getMessage())) {
|
||||||
|
return preset.getMessage();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use annotation value or default
|
||||||
|
return StringUtils.hasText(rateLimit.message())
|
||||||
|
? rateLimit.message()
|
||||||
|
: properties.getErrorResponse().getMessage();
|
||||||
|
}
|
||||||
|
}
|
||||||
3
src/main/resources/META-INF/spring.factories
Normal file
3
src/main/resources/META-INF/spring.factories
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Auto Configuration
|
||||||
|
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
|
||||||
|
tr.com.erato.RateLimit.config.RateLimitAutoConfiguration
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
tr.com.erato.RateLimit.config.RateLimitAutoConfiguration
|
||||||
1
src/main/resources/application.properties
Normal file
1
src/main/resources/application.properties
Normal file
@@ -0,0 +1 @@
|
|||||||
|
spring.application.name=spring-boot-starter-rate-limit
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
package tr.com.erato.RateLimit;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.springframework.boot.test.context.SpringBootTest;
|
||||||
|
|
||||||
|
@SpringBootTest
|
||||||
|
class SpringBootStarterRateLimitApplicationTests {
|
||||||
|
|
||||||
|
/* @Test
|
||||||
|
void contextLoads() {
|
||||||
|
}*/
|
||||||
|
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user