pippo

Marco web de Micro Java

Es un marco web de código abierto (licencia Apache) en Java, con dependencias mínimas y una curva de aprendizaje rápida.
El objetivo de este proyecto es crear un marco web micro en Java que debería ser fácil de usar y hackear.
El tamaño de pippo-core es de solo 140 kb y el tamaño de pippo-controller (opcional) es de solo 45 kb .

Código de muestra

1. Enfoque de rutas

Primero debemos crear una aplicación y agregar algunas rutas:

 public class BasicApplication extends Application {

    @ Override
    protected void onInit () {
        // send 'Hello World' as response
        GET ( "/" , routeContext -> routeContext . send ( "Hello World" ));

        // send a file as response
        GET ( "/file" , routeContext -> routeContext . send ( new File ( "pom.xml" )));

        // send a json as response
        GET ( "/json" , routeContext -> {
            Contact contact = createContact ();
            routeContext . json (). send ( contact );
        });

        // send xml as response
        GET ( "/xml" , routeContext -> {
            Contact contact = createContact ();
            routeContext . xml (). send ( contact );
        });

        // send an object and negotiate the Response content-type, default to XML
        GET ( "/negotiate" , routeContext -> {
            Contact contact = createContact ();
            routeContext . xml (). negotiateContentType (). send ( contact );
        });

        // send a template with name "hello" as response
        GET ( "/template" , routeContext -> {
            routeContext . setLocal ( "greeting" , "Hello" );
            routeContext . render ( "hello" );
        });
    }

    private Contact createContact () {
        return new Contact ()
            . setId ( 12345 )
            . setName ( "John" )
            . setPhone ( "0733434435" )
            . setAddress ( "Sunflower Street, No. 6" );
    }

}

donde Contact es un pojo simple:

 public class Contact  {

    private int id ;
    private String name ;
    private String phone ;
    private String address ;

    // getters and setters

}

El segundo paso es elegir su servidor favorito, motor de plantilla y motor de tipo de contenido.
Por ejemplo, elegiré Jetty como Server, Freemarker como Motor de plantilla, Jackson como Json Engine y JAXB como motor XML.
Mi maven pom.xml parece:

< dependency >
    < groupId >ro.pippo</ groupId >
    < artifactId >pippo-core</ artifactId >
    < version >${pippo.version}</ version >
</ dependency >

< dependency >
    < groupId >ro.pippo</ groupId >
    < artifactId >pippo-jetty</ artifactId >
    < version >${pippo.version}</ version >
</ dependency >

< dependency >
    < groupId >ro.pippo</ groupId >
    < artifactId >pippo-freemarker</ artifactId >
    < version >${pippo.version}</ version >
</ dependency >

< dependency >
    < groupId >ro.pippo</ groupId >
    < artifactId >pippo-jackson</ artifactId >
    < version >${pippo.version}</ version >
</ dependency >

El último paso es iniciar Pippo con su aplicación como parámetro:

 public class BasicDemo {

    public static void main ( String [] args ) {
        Pippo pippo = new Pippo ( new BasicApplication ());
        pippo . start ();
    }

}

Pippo inicia el servidor web integrado (que se encuentra en su classpath) y hace que la aplicación esté disponible en el puerto 8338 (valor predeterminado). Abra su navegador de Internet y consulte las rutas declaradas en la aplicación:

• http://localhost:8338
• http://localhost:8338/file
• http://localhost:8338/json
• http://localhost:8338/xml
• http://localhost:8338/negotiate
• http://localhost:8338/template

2. Enfoque de controladores

Definir el controlador (s):

 @ Path ( "/contacts" )
@ Logging
public class ContactsController extends Controller {

    private ContactService contactService ;

    public ContactsController () {
        contactService = new InMemoryContactService ();
    }

    @ GET
    @ Named ( "index" )
//    @Produces(Produces.HTML)
    @ Metered
    @ Logging
    public void index () {
        // inject "user" attribute in session
        getRouteContext (). setSession ( "user" , "decebal" );

        // send a template with name "contacts" as response
        getResponse ()
            . bind ( "contacts" , contactService . getContacts ())
            . render ( "contacts" );
    }

    @ GET ( "/uriFor/{id: [0-9]+}" )
    @ Named ( "uriFor" )
    @ Produces ( Produces . TEXT )
    @ Timed
    public String uriFor ( @ Param int id , @ Header String host , @ Session String user ) {
        System . out . println ( "id = " + id );
        System . out . println ( "host = " + host );
        System . out . println ( "user = " + user );

        Map < String , Object > parameters = new HashMap <>();
        parameters . put ( "id" , id );

        String uri = getApplication (). getRouter (). uriFor ( "api.get" , parameters );

        return "id = " + id + "; uri = " + uri ;
    }

    @ GET ( "/api" )
    @ Named ( "api.getAll" )
    @ Produces ( Produces . JSON )
    @ NoCache
    public List < Contact > getAll () {
        return contactService . getContacts ();
    }

    @ GET ( "/api/{id: [0-9]+}" )
    @ Named ( "api.get" )
    @ Produces ( Produces . JSON )
    public Contact get ( @ Param int id ) {
        return contactService . getContact ( id );
    }

}

 @ Path ( "/files" )
public class FilesController extends Controller {

    @ GET
    public void index () {
        // send a template with name "files" as response
        getRouteContext (). render ( "files" );
    }

    @ GET ( "/download" )
    public File download () {
        // send a file as response
        return new File ( "pom.xml" );
    }

    @ POST ( "/upload" )
    @ Produces ( Produces . TEXT )
    public String upload ( FileItem file ) {
        // send a text (the info about uploaded file) as response
//        return file.toString();
        return new StringBuilder ()
            . append ( file . getName ()). append ( " n " )
            . append ( file . getSubmittedFileName ()). append ( " n " )
            . append ( file . getSize ()). append ( " n " )
            . append ( file . getContentType ())
            . toString ();
    }

}

Agregar controlador (s) en su aplicación:

 public class BasicApplication extends ControllerApplication {

    @ Override
    protected void onInit () {
        addControllers ( ContactsController . class ); // one instance for EACH request
        // OR
        addControllers ( new ContactsController ()); // one instance for ALL requests

        addControllers ( FilesController . class );
    }

}

No olvide que el concepto Controller está incluido en el módulo pippo-controller , por lo que debe agregar este módulo como dependencia en su proyecto.

Documentación

La documentación está disponible en Pippo.RO

Manifestación

Las aplicaciones de demostración están disponibles en Pippo-Demo
Para una aplicación de la vida real construida con Pippo, mire la contabilidad web - Pippo Demo