Skip to content

Commit 137b731

Browse files
authored
Example realworldapp backend (#737)
* WIP initial implementation, User crud, half Article crud * WIP more article crud (update, complete fav/unfav) some refactor * WIP various bugfixes, making responses compatible with API * WIP finished articles + comments + tags crud. not bug checked though * minimal bugfix, added waitFor and refresh to post and delete methods * minor refactor, WIP documentation, added license * major refactor, added validation to user controller, WIP testcontainer unit test example * working testcontainer unit test * the rest of the test * style refactor, more documentation * fully documented user service, linting * code style * code style, a e s t e t h i c s * quick bug fixes * putting java instant directly into db * logic optimizations, hashing passwords * fixed unit test * more documentation * finished documenting methods, added README.md, set up gradle correctly, minor refactors * fixed readme, added license to all files * fixed readme * feed follow fix, shortened comment id
1 parent 280f846 commit 137b731

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+3333
-0
lines changed

examples/realworld-app/README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# ![RealWorld Example App](rw-logo.png)
2+
3+
> ### Spring Boot + Elasticsearch codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API
4+
5+
### [RealWorld](https://github.com/gothinkster/realworld)
6+
7+
This codebase was created to demonstrate a fully fledged fullstack application built with **Java + Spring Boot +
8+
Elasticsearch** including CRUD operations, authentication, routing, pagination, and more.
9+
10+
We've gone to great lengths to adhere to the **Java + Spring Boot + Elasticsearch** community styleguides & best
11+
practices.
12+
13+
For more information on how to this works with other frontends/backends, head over to
14+
the [RealWorld](https://github.com/gothinkster/realworld) repo.
15+
16+
# How it works
17+
18+
The application was made mainly demonstrate the
19+
new [Elasticsearch Java API Client](https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/index.html).
20+
21+
The application was built with:
22+
23+
- [Java](https://www.java.com/en/) as programming language
24+
- [Spring Boot](https://spring.io/projects/spring-boot) as dependency injection framework
25+
- [Gradle](https://github.com/gradle/gradle) as build tool
26+
- [Elasticsearch](https://github.com/elastic/elasticsearch) as database
27+
- [Jackson](https://github.com/FasterXML/jackson-core) as data bind serialization/deserialization
28+
- [Java JWT](https://github.com/jwtk/jjwt) for JWT implementation
29+
- [Jaxb](https://github.com/jakartaee/jaxb-api) for JWT parsing
30+
- [Slugify](https://github.com/slugify/slugify) for slug
31+
32+
Tests:
33+
34+
- [Junit](https://github.com/junit-team/junit4)
35+
- [Testcontainers](https://github.com/testcontainers) to create an Elasticsearch instance
36+
37+
#### Structure
38+
39+
This is a multimodule gradle project:
40+
41+
- rw-database
42+
- Elasticsearch client connection, queries, document classes
43+
- rw-rest
44+
- Spring rest controllers
45+
- rw-server
46+
- Configuration and entrypoint. Main class: [SpringBootApp.java](rw-server/src/main/java/realworld/SpringBootApp.java)
47+
48+
# Getting started
49+
50+
#### JVM
51+
52+
A version of the JVM has to be installed, openjdk version "21.0.2" was used during development.
53+
54+
#### Elasticsearch
55+
56+
An Elasticsearch instance needs to be running for the application to start successfully.
57+
To start one easily, a [docker-compose](docker-compose.yaml) is provided, it will start Elasticsearch on port 9200 and
58+
Kibana on [5601](http://localhost:5601/app/home#/); otherwise, the connection properties can be changed in [application.properties](rw-server/src/main/resources/application.properties).
59+
60+
### Build:
61+
62+
> ./gradlew clean build
63+
64+
#### Start the server:
65+
66+
> ./gradlew run
67+
68+
#### Run
69+
70+
The application will start on [8080](http://localhost:8080/api) with `api` context, it can be changed
71+
in [application.properties](rw-server/src/main/resources/application.properties).
72+
73+
### Unit tests
74+
75+
A basic [unit test](rw-database/src/test/java/realworld/db/UserServiceTest.java) using testcontainer (docker is
76+
required).

examples/realworld-app/build.gradle

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
plugins {
2+
id 'java'
3+
id 'org.springframework.boot' version '3.2.1'
4+
id 'io.spring.dependency-management' version '1.1.4'
5+
id 'application'
6+
}
7+
8+
group = 'realworldapp'
9+
version = '0.0.1-SNAPSHOT'
10+
11+
java {
12+
sourceCompatibility = '21'
13+
}
14+
15+
repositories {
16+
mavenCentral()
17+
}
18+
19+
dependencies {
20+
implementation('org.springframework.boot:spring-boot-starter-parent:3.2.0')
21+
implementation('realworldapp:rw-server')
22+
}
23+
24+
mainClassName = 'rw-server/src/main/java/realworld/SpringBootApp.java'
25+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
services:
2+
es:
3+
image: docker.elastic.co/elasticsearch/elasticsearch:8.11.1
4+
container_name: es
5+
environment:
6+
"discovery.type": "single-node"
7+
"xpack.security.enabled": "false"
8+
"xpack.security.http.ssl.enabled": "false"
9+
ports:
10+
- "9200:9200"
11+
networks:
12+
- elastic
13+
kibana:
14+
image: docker.elastic.co/kibana/kibana:8.7.1
15+
container_name: kibana
16+
environment:
17+
XPACK_ENCRYPTEDSAVEDOBJECTS_ENCRYPTIONKEY: d1a66dfd-c4d3-4a0a-8290-2abcb83ab3aa
18+
ports:
19+
- 5601:5601
20+
networks:
21+
- elastic
22+
deploy:
23+
resources:
24+
limits:
25+
cpus: '2.0'
26+
reservations:
27+
cpus: '1.0'
28+
networks:
29+
elastic:
Binary file not shown.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
4+
networkTimeout=10000
5+
validateDistributionUrl=true
6+
zipStoreBase=GRADLE_USER_HOME
7+
zipStorePath=wrapper/dists

examples/realworld-app/gradlew

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
1+
#!/bin/sh
2+
3+
#
4+
# Copyright © 2015-2021 the original authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
19+
##############################################################################
20+
#
21+
# Gradle start up script for POSIX generated by Gradle.
22+
#
23+
# Important for running:
24+
#
25+
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
26+
# noncompliant, but you have some other compliant shell such as ksh or
27+
# bash, then to run this script, type that shell name before the whole
28+
# command line, like:
29+
#
30+
# ksh Gradle
31+
#
32+
# Busybox and similar reduced shells will NOT work, because this script
33+
# requires all of these POSIX shell features:
34+
# * functions;
35+
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
36+
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
37+
# * compound commands having a testable exit status, especially «case»;
38+
# * various built-in commands including «command», «set», and «ulimit».
39+
#
40+
# Important for patching:
41+
#
42+
# (2) This script targets any POSIX shell, so it avoids extensions provided
43+
# by Bash, Ksh, etc; in particular arrays are avoided.
44+
#
45+
# The "traditional" practice of packing multiple parameters into a
46+
# space-separated string is a well documented source of bugs and security
47+
# problems, so this is (mostly) avoided, by progressively accumulating
48+
# options in "$@", and eventually passing that to Java.
49+
#
50+
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
51+
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
52+
# see the in-line comments for details.
53+
#
54+
# There are tweaks for specific operating systems such as AIX, CygWin,
55+
# Darwin, MinGW, and NonStop.
56+
#
57+
# (3) This script is generated from the Groovy template
58+
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
59+
# within the Gradle project.
60+
#
61+
# You can find Gradle at https://github.com/gradle/gradle/.
62+
#
63+
##############################################################################
64+
65+
# Attempt to set APP_HOME
66+
67+
# Resolve links: $0 may be a link
68+
app_path=$0
69+
70+
# Need this for daisy-chained symlinks.
71+
while
72+
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
73+
[ -h "$app_path" ]
74+
do
75+
ls=$( ls -ld "$app_path" )
76+
link=${ls#*' -> '}
77+
case $link in #(
78+
/*) app_path=$link ;; #(
79+
*) app_path=$APP_HOME$link ;;
80+
esac
81+
done
82+
83+
# This is normally unused
84+
# shellcheck disable=SC2034
85+
APP_BASE_NAME=${0##*/}
86+
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
87+
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
88+
89+
# Use the maximum available, or set MAX_FD != -1 to use that value.
90+
MAX_FD=maximum
91+
92+
warn () {
93+
echo "$*"
94+
} >&2
95+
96+
die () {
97+
echo
98+
echo "$*"
99+
echo
100+
exit 1
101+
} >&2
102+
103+
# OS specific support (must be 'true' or 'false').
104+
cygwin=false
105+
msys=false
106+
darwin=false
107+
nonstop=false
108+
case "$( uname )" in #(
109+
CYGWIN* ) cygwin=true ;; #(
110+
Darwin* ) darwin=true ;; #(
111+
MSYS* | MINGW* ) msys=true ;; #(
112+
NONSTOP* ) nonstop=true ;;
113+
esac
114+
115+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
116+
117+
118+
# Determine the Java command to use to start the JVM.
119+
if [ -n "$JAVA_HOME" ] ; then
120+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
121+
# IBM's JDK on AIX uses strange locations for the executables
122+
JAVACMD=$JAVA_HOME/jre/sh/java
123+
else
124+
JAVACMD=$JAVA_HOME/bin/java
125+
fi
126+
if [ ! -x "$JAVACMD" ] ; then
127+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
128+
129+
Please set the JAVA_HOME variable in your environment to match the
130+
location of your Java installation."
131+
fi
132+
else
133+
JAVACMD=java
134+
if ! command -v java >/dev/null 2>&1
135+
then
136+
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137+
138+
Please set the JAVA_HOME variable in your environment to match the
139+
location of your Java installation."
140+
fi
141+
fi
142+
143+
# Increase the maximum file descriptors if we can.
144+
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
145+
case $MAX_FD in #(
146+
max*)
147+
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
148+
# shellcheck disable=SC2039,SC3045
149+
MAX_FD=$( ulimit -H -n ) ||
150+
warn "Could not query maximum file descriptor limit"
151+
esac
152+
case $MAX_FD in #(
153+
'' | soft) :;; #(
154+
*)
155+
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
156+
# shellcheck disable=SC2039,SC3045
157+
ulimit -n "$MAX_FD" ||
158+
warn "Could not set maximum file descriptor limit to $MAX_FD"
159+
esac
160+
fi
161+
162+
# Collect all arguments for the java command, stacking in reverse order:
163+
# * args from the command line
164+
# * the main class name
165+
# * -classpath
166+
# * -D...appname settings
167+
# * --module-path (only if needed)
168+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
169+
170+
# For Cygwin or MSYS, switch paths to Windows format before running java
171+
if "$cygwin" || "$msys" ; then
172+
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
173+
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
174+
175+
JAVACMD=$( cygpath --unix "$JAVACMD" )
176+
177+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
178+
for arg do
179+
if
180+
case $arg in #(
181+
-*) false ;; # don't mess with options #(
182+
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
183+
[ -e "$t" ] ;; #(
184+
*) false ;;
185+
esac
186+
then
187+
arg=$( cygpath --path --ignore --mixed "$arg" )
188+
fi
189+
# Roll the args list around exactly as many times as the number of
190+
# args, so each arg winds up back in the position where it started, but
191+
# possibly modified.
192+
#
193+
# NB: a `for` loop captures its iteration list before it begins, so
194+
# changing the positional parameters here affects neither the number of
195+
# iterations, nor the values presented in `arg`.
196+
shift # remove old arg
197+
set -- "$@" "$arg" # push replacement arg
198+
done
199+
fi
200+
201+
202+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
203+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
204+
205+
# Collect all arguments for the java command:
206+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
207+
# and any embedded shellness will be escaped.
208+
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
209+
# treated as '${Hostname}' itself on the command line.
210+
211+
set -- \
212+
"-Dorg.gradle.appname=$APP_BASE_NAME" \
213+
-classpath "$CLASSPATH" \
214+
org.gradle.wrapper.GradleWrapperMain \
215+
"$@"
216+
217+
# Stop when "xargs" is not available.
218+
if ! command -v xargs >/dev/null 2>&1
219+
then
220+
die "xargs is not available"
221+
fi
222+
223+
# Use "xargs" to parse quoted args.
224+
#
225+
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
226+
#
227+
# In Bash we could simply go:
228+
#
229+
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
230+
# set -- "${ARGS[@]}" "$@"
231+
#
232+
# but POSIX shell has neither arrays nor command substitution, so instead we
233+
# post-process each arg (as a line of input to sed) to backslash-escape any
234+
# character that might be a shell metacharacter, then use eval to reverse
235+
# that process (while maintaining the separation between arguments), and wrap
236+
# the whole thing up as a single "set" statement.
237+
#
238+
# This will of course break if any of these variables contains a newline or
239+
# an unmatched quote.
240+
#
241+
242+
eval "set -- $(
243+
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
244+
xargs -n1 |
245+
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
246+
tr '\n' ' '
247+
)" '"$@"'
248+
249+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)