Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/byronka/minum

A minimalist Java web framework built from scratch
https://github.com/byronka/minum

framework java minimalism tdd web

Last synced: 3 months ago
JSON representation

A minimalist Java web framework built from scratch

Awesome Lists containing this project

README 

        
Minum Web Framework

===================



_When you need the fewest moving parts_



The simplest Minum program (see more [code samples](#code-samples) below):



```Java

public class Main {

    public static void main(String[] args) {

        var minum = FullSystem.initialize();

        var wf = minum.getWebFramework();

        wf.registerPath(GET, "",

                r -> Response.htmlOk("
Hi there world!
"));

        minum.block();

    }

}

```



What is this?

--------------



This web framework, "Minum", provides an all-in-one minimalist foundation for a highly-maintainable 

single-binary web application. For TDD, by TDD.



* Has its own web server, endpoint routing, logging, templating engine, html parser, assertions framework, and database

* Around 100% test coverage that runs in 30 seconds without any special setup (`make test_coverage`)

* Nearly 100% mutation test strength using the [PiTest](https://pitest.org/) tool. (`make mutation_test`)

* Relies on no dependencies other than the Java 21 SDK - i.e. no Netty, Jetty, Tomcat, Log4j, Hibernate, MySql, etc.

* Well-documented

* Uses no reflection

* Requires no annotations

* No magic

* Has [examples of framework use](#example-projects-demonstrating-usage):

  * a tiny project, as the basis to get started

  * a small project, showing some minimal use cases

  * a full application demonstrating realistic usage



Minum is five thousand lines of code - the "minimalist" competitors range from 400,000 to 700,000 lines when 

accounting for their dependencies. I have not found a similar project.



Applying a minimalist approach enables easier debugging, maintainability, and lower overall cost. Most 

frameworks trade faster start-up for a higher overall cost. If you need sustainable quality, the software 

must be well-tested and documented from the onset.  As an example, this project's ability to attain such

high test coverage was greatly enabled by the minimalism paradigm.



Getting Started

---------------



There is a 🚀 [Quick start](docs/quick_start.md), or if you have

a bit more time, consider trying the [tutorial](docs/getting_started/getting_started.md)



Maven

-----



```xml



    com.renomad

    minum

    5.0.0



```



Features:

--------



- [Secure TLS 1.3 HTTP/1.1 web server](src/main/java/com/renomad/minum/web)

- [In-memory database with disk persistence](src/main/java/com/renomad/minum/database)

- [Server-side templating](src/main/java/com/renomad/minum/templating)

- [Logging framework](src/main/java/com/renomad/minum/logging)

- [Testing framework](src/main/java/com/renomad/minum/testing)

- [HTML parsing](src/main/java/com/renomad/minum/htmlparsing) 

- [Background queue processor](src/main/java/com/renomad/minum/queue) 



Size Comparison:

----------------



Compiled size: 180 kilobytes.



_Lines of production code (including required dependencies)_



| Minum | Javalin | Spring Boot |

|-------|---------|-------------|

| 4,570 | 141,048 | 1,085,405   |



See [details](docs/size_comparisons.md)



Performance:

------------



* 19,000 http web server responses per second. [detail](docs/perf_data/response_speed_test.md)

* 2,000,000 database updates per second. [detail](docs/perf_data/database_speed_test.md)

* 31,717 templates rendered per second. See "test_Templating_Performance" [here](src/test/java/com/renomad/minum/templating/TemplatingTests.java).

  Also, see this [comparison benchmark](https://github.com/byronka/template-benchmark?tab=readme-ov-file#original-string-output-test), with Minum's

  code represented [here](https://github.com/byronka/template-benchmark/blob/utf8/src/main/java/com/mitchellbosecke/benchmark/Minum.java).



See [framework performance comparison](docs/perf_data/framework_perf_comparison.md)



Documentation:

--------------



* [Development handbook](docs/development_handbook.md)

* [Javadocs](https://renomad.com/javadoc/)

* [Code coverage](https://renomad.com/site/jacoco/index.html) 

* [Mutation test report](https://renomad.com/pit-reports)

* [Various reports](https://renomad.com/site/project-reports.html) 



Example projects demonstrating usage:

-------------------------------------



See the following links for sample projects that use this framework.



[Smallest-possible](https://github.com/byronka/minum_usage_example_smaller)



This project is valuable to see the minimal-possible application that can

be made.  This might be a good starting point for use of Minum on a new project.






[Example](https://github.com/byronka/minum_usage_example_mvn) 



This is a good example to see a basic project with various functionality. It

shows many of the typical use cases of the Minum framework.






[Memoria project](https://github.com/byronka/memoria_project)



This is a family-tree project.  It demonstrates the kind of

approach this framework is meant to foster.



Code samples

------------



Instantiating a new database:



```java

var db = new Db<>(foosDirectory, context, new Foo());

```



Adding a new object to a database:



```java

var foo = new Foo(0L, 42, "blue");

db.write(foo);    

```



Updating an object in a database:



```java

foo.setColor("orange");

db.write(foo);    

```



Deleting from a database:



```java

db.delete(foo);    

```



Writing a log statement:



```java

logger.logDebug(() -> "hello");

```



Parsing an HTML document:



```java

List results = new HtmlParser().parse("
");

```



Searching for an element in the parsed graph:



```java

HtmlParseNode node;

List results = node.search(TagName.P, Map.of());

```



Creating a new web handler (a function that handles an HTTP request and

returns a response):

```java

public Response myHandler(Request r) {

  return Response.htmlOk("
Hi world!
");

}

```



Registering that endpoint:



```java

webFramework.registerPath(GET, "formentry", sd::formEntry);

```



Building and rendering a template:



```java

TemplateProcessor foo = TemplateProcessor.buildProcessor("hello {{ name }}");

String rendered = foo.renderTemplate(Map.of("name", "world"));

```



Getting a query parameter from a request:



```java

String id = r.requestLine().queryString().get("id");

```



Getting a body parameter from a request, as a string:



```java

String personId = request.body().asString("person_id");

```



Get a path parameter from a request as a string:



```java

Pattern requestRegex = Pattern.compile(".well-known/acme-challenge/(?.*$)");

final var challengeMatcher = requestRegex.matcher(request.requestLine().getPathDetails().isolatedPath());

// When the find command is run, it changes state so we can search by matching group

if (! challengeMatcher.find()) {

    return new Response(StatusLine.StatusCode.CODE_400_BAD_REQUEST);

}

String tokenFileName = challengeMatcher.group("challengeValue");

```



Getting a body parameter from a request, as a byte array:



```java

byte[] photoBytes = body.asBytes("image_uploads");

```



Checking for a log message during tests:



```java

assertTrue(logger.doesMessageExist("Bad path requested at readFile: ../testingreadfile.txt"));

```