minicore parent
minicore- framework
minicore -archetype
minicore-archetype for client creation
mvn archetype:generate
-DarchetypeGroupId=io.github.priyanhsu10
-DarchetypeArtifactId=minicore-archetype
-DarchetypeVersion=0.0.1
Minicore is a JVM base cross-platform, high-performance, open-source framework for building modern, cloud-enabled, Internet-connected apps.
It is heavily in inspired by the Aspnet Core and Express. Curently Minicore framework is in the development phase ,Basic work flow is ready for creating api :)
- Pipeline Creation for for request
- Routing
- Global exception hanlding
- Filters
- Global level Filter configuration
- Controller level Filter configuration
- Action level Filter configuration
- Content negociation using Formatters
- Input Formatters
- Output Formatters
Currently I am looking for contributors for the project and need your help to make this project successfull
You can find the Github Project Requirement gathering board Link here
comminig soon ..
public class Program {
public static void main(String[] args) {
WebHostBuilder.build(args)
//configure custom properties
.ConfigureHost(option->{
//add your custom property file
// option.addPropertyFile("CustomFile.properties");
//------------------------*-Need to be implemented-----*--------------
//add your custom json file
// option.addJsonFile("CustomjsonFile.json");
//add your custom xml file
// option.addXmlFile("CustomxmlFile.xml");
//------------------------*-Need to be implemented------*-------------
})
.useStartup(AppStartup.class)
.run();
}
}comminig soon ..
public class AppStartup implements IStartup {
//Register your service with IOC Container
@Override
public void configureServices(IServiceCollection service) {
//configuring mvc options
MvcConfigurer.configureMvc(service,options->{
// Adding your custom Global filters
options.addGlobalFilter(TestGlobalActionFilter.class);
//Adding your Custom Exception Filters
options.addExceptionFilter(TestExceptionFilter.class);
// Adding your custom Global Result filters
// Global filter will execute for every action before writing the response
options.addResultFilter(TestResultFilter.class);
});
//Resigter your dependencies with the IOC Container like below
service.addSingleton(ITestService.class, TestService.class);
}
//build your pipeline
@Override
public void configure(IApplicationBuilder app) {
app.use(TransactionIdMiddleware.class);-->//Custom Middleware added in the pipeline
//route endPoint selector
app.useRouting();
//add custom middlewares
app.use(CustomMiddleware.class);
... --> Other custom midlewares
app.useEndpoints();//Endpoint executor
}
}comminig soon ..
In startup class pipeline can be cofnigre in configure method ..
public class AppStartup implements IStartup {
...
//build your pipeline
@Override
public void configure(IApplicationBuilder app) {
//create your own pipeline :D
app.use(TransactionIdMiddleware.class);
app.useRouting(); //route EndPoint selector
//add custom middlewares
app.use(CustomMiddleware.class);
... --> Other custom midlewares
app.useEndpoints();//Endpoint executor (This should be the last midleware in the pipeline because after this next middleware wont call)
}
}You can create the controller by extending the controllerBase class
@Route(path = "/hello") --> @Route Annoation setut the base route for Controller
@ActionFilter(filterClass = TestActionFilter2.class) ---> Controller Level Action filter . this is exectuted On every action execution in the controller
public class HelloController extends ControllerBase {
private ITestService testService;
public HelloController(ITestService testService) { ---> Inject Dependency using Contructor Injection
this.testService = testService;
}
@Get //--> Using @Get attribute can specify Get Method
@ActionFilter(filterClass = TestActionFilter.class) --> //apply custom filter for specific action
@ResultFilter(filterClass = CustomResultFilter.class) --> //custom Result Filter Which Before Result Execution. at this poit you can change the respose.
public List<Model> get() {
//accesing transaiton id which is added by transactionIdMiddlware
System.out.println(httpContext.getData().get("trazId"));
return this.testService.getlist();
}
@Get(path = "/:id") --> //we can specify route templete like this eg "<route>/:{parameter from route}" this case route will be hello/:id
public Model get(int id) {
return this.testService.getById(id);
}
@Get(path = "/filter") //value bind from query
public List<Model> get(@FromQuery String name) {
return this.testService.getlist().stream().filter(x->x.getName().equals(name)).collect(Collectors.toList());
}
@Post
//Direct Model binding use @FromBody annotation
public Model post(@FromBody Model model){
return testService.create(model);
}
@Post(path = "/m2")
//Custom ModelBiding
public Model post( Model2 model){
return model.getModel();
}
@Put(path = "/update")
public String put(String name){
return "this is post "+name;
}
@Delete(path = "/delete")
public String delete(String name){
return "this is post "+name;
}
}comminig soon ..
comminig soon ..
comminig soon ..
comminig soon ..
comminig soon ..
Minicore can pick the configuration in following order
- app.properties
- app.{profile}.properties
- custom property configuration provider
- Envronment variables entries 5.Command line Aguments -m_{propertykey}=value
public class Program {
public static void main(String[] args) {
WebHostBuilder.build(args)
//configure custom properties
.ConfigureHost(option->{
//add your custom property file
// option.addPropertyFile("CustomFile.properties");
//add your custom json file
// option.addJsonFile("CustomjsonFile.json");
//add your custom xml file
// option.addXmlFile("CustomxmlFile.xml");
options.custom(()->{
Map<Object,Object> customProperties= new HashMap<>();
//custom keys
....
return customProperties;
}));
})
.useStartup(AppStartup.class)
.run();
}
}Micore proved the the following depencency type to be register
- Singleton
- RequestScope
- Transient
IServiceCollection interface is provide the functionality to resole the and register the types to IOC container ..
public class AppStartup implements IStartup {
//Register your service with IOC Container
@Override
public void configureServices(IServiceCollection service) {
//Resigter your dependencies with the IOC Container like below
service.addSingleton(ITestService.class, TestService.class);
}
.....
Use the dependencies
public class HelloController extends ControllerBase {
private ITestService testService;
public HelloController(ITestService testService) { ---> Inject Dependency using Contructor Injection
this.testService = testService;
}comminig soon ..
Http Route Annotations
- @Route
- @Get
- @Put
- @Post
- @Delete
Model binding can be perform in using following annotations
- @FromBody
- @FromForm
- @FromRoute
- @FromQuery
custom Model biding Model
@Post(path = "/m2")
//Custom ModelBiding
public Model post( Model2 model){
return model.getModel();
}
....
//Custom ModelBiding
public class Model2 {
//value bind from header
@FromHeader(Key = "Authorization")
private String token;
//value bind from Query
@FromQurey
private String name;
//value bind from Route
@FromRoute
private String id;
//value bind from Body
@FromBody
private Model model;
....
setter getter
}comminig soon ..
Filters allow to run the code at veriaus stage
Minicor provide 4 types of filters
- Authorization filter [need to be impletemented]
- Action Filter
- Exception Filter
- Result Filter
coming soon ...
Action filters allow to run the code before and after action execute Action filter can be define by impletementing the IAcitonFilter Interface
Execution of Pipeline can be short circuited if you set the result field
public class TestActionFilter implements IActionFilter {
//execute method before action call
@Override
public void beforeExecute(HttpContext httpContext) {
//contain the action parameters that you can change
// httpContext.ActionContext.MethodParameters
System.out.println("TestActionFilter :beforeExecute");
//for short-circuiting pipe set action result value
//httpContext.ActionContext.ActionResult
// example httpContext.ActionContext.ActionResult= new NotFoundResult();
}
@Override
public void afterExecute(HttpContext httpContext) {
//perform any logic after action execution
// here Action result will be present
System.out.println("TestActionFilter :afterExecute");
}
}
...We can configure the Filter on Three level
- Global Level Action Filter
Global filter will excetute against every action . Global filter can be register in the Startup class ConfigureServices method
public class AppStartup implements IStartup {
//Register your service with IOC Container
@Override
public void configureServices(IServiceCollection service) {
//configuring mvc options
MvcConfigurer.configureMvc(service,options->{
// Adding your custom Global filters
options.addGlobalFilter(TestGlobalActionFilter.class);
.....
});
}
...
}- Controller Level Action Fitler
Controller level Action filter can be apply using @ActionFilter Annotation on controller class and provide the your custom filter like @ActionFilter(filterClass = TestActionFilter2.class)
Filter will be excecute on every action of controller class
@Route(path = "/hello") --> @Route Annoation setut the base route for Controller
@ActionFilter(filterClass = TestActionFilter2.class) ---> Controller Level Action filter . this is exectuted On every action execution in the controller
public class HelloController extends ControllerBase {
private ITestService testService;
public HelloController(ITestService testService) { ---> Inject Dependency using Contructor Injection
this.testService = testService;
}
....- Action Level Action Filter
Action Level Filter can ye use same as contoller level filter . we have to apply the annotation on Action in place of Controller class
You can apply multiple filter as well the order of execution as per you apply
@Get //--> Using @Get attribute can specify Get Method
@ActionFilter(filterClass = TestActionFilter.class) --> //apply custom filter for specific action
public List<Model> get() {
//accesing transaiton id which is added by transactionIdMiddlware
System.out.println(httpContext.getData().get("trazId"));
return this.testService.getlist();
}Exception Filter allow to handle the the custom exception which will throw from the action method
We can define the our custom ExceptionFilter by implementing the IExceptionFilter interface
IExceptionFilter fitler have 2 Methods
-
boolean support(..)
This method decide the elegibility of ExcptionFilter for thrown exception.
-
onException(..) This method can give the control to you to handle the exception
public class TestExceptionFilter implements IExceptionFilter {
@Override
public boolean support(Class<? extends RuntimeException> excetpions) {
//from list of exception filter support method decide for handling exception
return excetpions.equals(TestCustomException.class);
}
@Override
public <T extends RuntimeException> void onException(HttpContext context, T e) {
//handle your custom exception
context.ActionContext.ActionResult= new BadRequestResult(e.getLocalizedMessage());
}
}
Exception fitler can be Configure globally in Startup Class in configureServices method . where we can register the Custom Exception fitler with MvcConfigurer using options.addExceptionFilter(..).
public class AppStartup implements IStartup {
//Register your service with IOC Container
@Override
public void configureServices(IServiceCollection service) {
//configuring mvc options
MvcConfigurer.configureMvc(service,options->{
//Adding your Custom Exception Filters
options.addExceptionFilter(TestExceptionFilter.class);
});
}
...Result filter can be excecuted just before writing the response . at this stage you can change the result fromthe action method at all .
We can define the Result filter by implemeting IResultExecutionFilter
public class TestResultFilter implements IResultExecutionFilter {
@Override
public void beforeResultExecute(HttpContext httpContext) {
System.out.println("TestResultFilter:executed");
//writing custom Header for
httpContext.getResponse().addHeader("Framwork-Name","Minicore");
httpContext.getResponse().addHeader("Developer","Priyanshu Parate");
}
}We can appply the Result Filter at global level and Action Level
- Global level Global result fitler will excecute for every action We can register the Custom Result filter with MvcConfigurer using options.addResultFilter()
public class AppStartup implements IStartup {
//Register your service with IOC Container
@Override
public void configureServices(IServiceCollection service) {
//configuring mvc options
MvcConfigurer.configureMvc(service, options -> {
// Adding your custom Global Result filters
// Global filter will execute for every action before writing the response
options.addResultFilter(TestResultFilter.class);
});
...
}- Action level You can apply Result fitler for specific action using @ResultFilter
@Get
@ActionFilter(filterClass = TestActionFilter.class)
//apply custom filter for specific action
@ResultFilter(filterClass = CustomResultFilter.class)
public List<Model> get() {
Integer value= iConfiguration.getValue(Integer.class,"age");
System.out.println("value from Conguraton age:"+value);
//accesing transaiton id which is added by transactionIdMiddlware
System.out.println(httpContext.getData().get("trazId"));
return this.testService.getlist();
}comminig soon ..
comminig soon ..
comminig soon ..
comminig soon ..