README.md

Webmind Framework

Webmind is a lightweight web service framework that integrates with SpringFramework. Realize the embedded startup of Tomcat, which is easy to use, occupies less memory, responds quickly, and has stable service. Suitable for Java microservices and web projects.

Maven

Add the following Maven dependency to your project's pom.xml

<dependency>
    <groupId>io.github.dilldong</groupId>
    <artifactId>webmind-framework</artifactId>
    <version>4.6.3.RELEASE</version>
</dependency>

Gradle

implementation 'io.github.dilldong:webmind-framework:4.6.3.RELEASE'

Example

1. Mapping

@Controller
public class HelloController {
    
    @Mapping
    public String first() {
        return "Welcome usage Webmind-Framework.";
    }

    // Spec a GET request, text response.
    @Mapping(value = "/request/text", method = RequestMethod.GET)
    public String withText() {
        return "Hello,This is Webmind-Framework.";
    }
    
    // Spec a URL parameter, text response.
    @Mapping(value = "/request/text/${name}", method = RequestMethod.GET)
    public String withText(String name) {
        return "Hello "+ name +",This is Webmind-Framework.";
    }

    // Json response
    @Mapping("/request/json")
    public Response<String> withJson() {
        return new Response<String>(HttpStatus.SC_OK, "OK");
    }

    // Json body response
    @Mapping("/request/json2")
    public String withJsonResult() {
        return new Response<Map<String, Object>>(HttpStatus.SC_OK, "OK")
                .setResult(ImmutableMap.of("nickName", "Smith", "age", 26, "gender", "Male"))
                .toJson();
    }

    // redirect
    @Mapping("/request/redirect")
    public String redirect() {
        return "redirect:https://github.com/dilldong";
    }

    // forward
    @Mapping("/request/forward")
    public String forward() {
        return "forward:https://github.com/dilldong";
    }

    // javascript response
    @Mapping("/request/js")
    public String js() {
        return "script:alert('This is JS window.');";
    }

    // velocity template engine
    @Mapping("/request/velocity")
    public Render velocity() {
        return new TemplateRender("/template/index.vm");
    }
}

2. Interceptor

@Component
@Interceptor(value = {"/user/*"}, excludes = {"/login"})
public class InterceptorClass extends AbstractHandlerInterceptor {
    // Processing your business
}

3. Filter

@Component
@Filter(value = {"/*"})
public class WebFilter extends AbstractHandlerFilter {
    // Processing your business
}

4. CrossOrigin Spring-based CrossOrigin annotation

@Controller
public class GithubController {

    @Mapping
    @CrossOrigin("*.github.com")
    public String fromGithub() {
        // Processing your business
    }
}

5. Startup Web Application

@Import(AppConfiguration.class)
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

or

public class Application {
    public static void main(String[] args) {
        SpringApplication.run(
                new String[]{"springContext.xml", "mybatisplusConfig.xml"},
                args);
    }
}

6. Startup Non-Web Application

@Import(AppConfiguration.class)
public class Application {
    public static void main(String[] args) {
        SpringApplication application = SpringApplication.runApplication(Application.class, args);
        
        // start your business
        ContextSupport.getBeans(StartService.class).forEach((k, v) -> {
            v.doStart();
        });

        // shutdown for waiting
        application.waiting(20L, TimeUnit.SECONDS);
    }
}

or

public class Application {
    public static void main(String[] args) {
        SpringApplication application =
                SpringApplication.runApplication(
                        new String[]{"springContext.xml", "mybatisplusConfig.xml"},
                        args);
                        
        // start your business                
        ContextSupport.getBeans(StartService.class).forEach((k, v) -> {
            v.doStart();
        });

        // shutdown for waiting
        application.waiting(20L, TimeUnit.SECONDS);
    }
}

License

The Webmind Framework is released under version 2.0 of the Apache License.