jpipe Download - jpipe Source code download

Jpipe

A Java implementation of Facebook's bigPipe technology.

Jpipe is implemented through custom tags, so it has zero intrusion into the backend code.

HTML is a function that completes the foreground page, while custom tags can complete certain operations in the background.

characteristic

jsp tag support
freemarker command support
Use jsp tags in freemarker

Why use BigPipe

Solve the speed bottleneck
Reduce delay time

What scenario is BigPipe suitable for?

Mainly applicable to:

The request time is long, and the backend program needs to read multiple APIs to obtain data
The page content can be divided into multiple blocks to display, and the correlation between each block is not large (loosely coupled)
Weak demand for SEO

Comparison of multiple implementation methods

type	Number of requests	Server-side pressure	User Experience	Web page loading speed	Module loading order	Difficulty to achieve	Difficulty in post-maintenance
ordinary	1	Small	Difference	slow	Document flow order	Simple	generally
Ajax	many	big	good	quick	uncertain	difficulty	difficulty
Single-threaded BigPipe	1	Small	good	slow	Customize	generally	generally
Multithreaded BigPipe	1	General (caused by thread pool)	good	Fastest	uncertain	The most difficult	generally

start

Thread pool configuration

property	type	Is it required	Default value	illustrate	describe
core-size	int	no	-1	Number of core threads	Minimum number of idle threads, minimum number of threads that will survive anyway
max-size	int	no	1024	Maximum number of threads	Jpipe can create the maximum number of threads used to process pagelets
queue-size	int	no	1024	Maximum waiting co-column count	Request concurrency is greater than max-size, and it will be put into the queue and wait.
Keep-alive	long	no	60000	Maximum idle time (ms)	If the number of threads exceeds core-size, it will be recycled until the number of threads equals core-size.
pre-start-all-core-threads	boolean	no	false	Preheat thread pool	Whether to pre-start core-size threads

pepe tags, commands

property	type	Is it required	Default value	illustrate	describe
async	boolean	no	true	Whether to execute pagelet tasks asynchronously

pagelet tags, commands

property	type	Is it required	Default value	illustrate
domid	string	yes		html document Id
bean	string	yes		spring bean name
var	string	yes		variable parameters
URI	string	no		uri parameters
jsmethod	string	no	JP.view	js function that wraps data

Integrate with Spring

Through JpipeThreadPoolFactoryBean class

<? xml version = " 1.0 " encoding = " UTF-8 " ?>
< beans xmlns = " http://www.springframework.org/schema/beans "
       xmlns : xsi = " http://www.w3.org/2001/XMLSchema-instance "
       xsi : schemaLocation = " http://www.springframework.org/schema/beans
		http://www.springframework.org/schema/beans/spring-beans.xsd " >

    < bean class = " top.ylonline.jpipe.spring.JpipeSpringFactoryBean " />
    
    < bean id = " pool-1 " class = " top.ylonline.jpipe.threadpool.common.Pool " >
        < property name = " coreSize " value = " -1 " />
        < property name = " maxSize " value = " 20 " />
        < property name = " preStartAllCoreThreads " value = " false " />
        < property name = " keepAlive " value = " 12000000 " />
        < property name = " queueSize " value = " 500 " />
    </ bean >

    <!-- 工场模式 -->
    < bean class = " top.ylonline.jpipe.threadpool.util.JpipeThreadPoolFactoryBean " >
        < property name = " pool " ref = " pool-1 " />
    </ bean >

    <!-- 或者 
    <bean class="top.ylonline.jpipe.threadpool.util.JpipeThreadPoolFactoryBean">
        <property name="pool">
            <bean class="top.ylonline.jpipe.threadpool.common.Pool">
                <property name="coreSize" value="4"/>
                <property name="maxSize" value="10"/>
                <property name="preStartAllCoreThreads" value="true"/>
                <property name="keepAlive" value="60000"/>
                <property name="queueSize" value="500"/>
            </bean>
        </property>
    </bean>
	-->
</ beans >

Through JpipeThreadPoolBuilder class

<? xml version = " 1.0 " encoding = " UTF-8 " ?>
< beans xmlns = " http://www.springframework.org/schema/beans "
       xmlns : xsi = " http://www.w3.org/2001/XMLSchema-instance "
       xsi : schemaLocation = " http://www.springframework.org/schema/beans
		http://www.springframework.org/schema/beans/spring-beans.xsd " >

    < bean class = " top.ylonline.jpipe.spring.JpipeSpringFactoryBean " />
    
    <!-- builder 模式 -->
    < bean id = " jpipeThreadPoolBuilder " class = " top.ylonline.jpipe.threadpool.util.JpipeThreadPoolBuilder " >
        < property name = " pool " >
            < bean class = " top.ylonline.jpipe.threadpool.common.Pool " >
                < property name = " coreSize " value = " 1 " />
                < property name = " maxSize " value = " 1 " />
                < property name = " preStartAllCoreThreads " value = " true " />
                < property name = " keepAlive " value = " 1 " />
                < property name = " queueSize " value = " 1 " />
            </ bean >
        </ property >
    </ bean >
    < bean id = " jpipeThreadPool-3 " factory-bean = " jpipeThreadPoolBuilder " factory-method = " build " />
</ beans >

Through JavaBean

 @ Bean
public JpipeSpringFactoryBean jpipeSpringFactoryBean (){
    return new JpipeSpringFactoryBean ();
}

@ Bean
public JpipeThreadPoolExecutor jpipeThreadPoolExecutor () {
    Pool pool = new Pool ();
    pool . setCoreSize ( 10 );
    pool . setMaxSize ( 1024 );
    pool . setPreStartAllCoreThreads ( true );
    pool . getKeepAlive ( 60000 );
    pool . getQueueSize ( 512 );
    // return new EagerThreadPool().getExecutor(pool);
    return new JpipeThreadPoolBuilder ( pool ). build ();
}

via spring-boot starter

pom.xml dependency

< dependency >
    < groupId >top.ylonline.jpipe</ groupId >
    < artifactId >jpipe-spring-boot-starter</ artifactId >
    < version >${version}</ version >
</ dependency >

application.yml configuration

 jpipe :
  # enabled: true
  pool :
    pre-start-all-core-threads : true
    core-size : -1
    max-size : 20
    queue-size : 10
    keep-alive : 10000

Define a pagelet

Use Spring's @Service to define a pagelet to implement the doExec method of the PageletBean interface

 @ Service ( "testPagelet1" )
public class PageletServiceTest implements PageletBean {

    @ Override
    public Map < String , Object > doExec ( final Map < String , String > params ) {
        Map < String , Object > data = new HashMap <>( params );
        try {
            TimeUnit . MILLISECONDS . sleep ( new Random (). nextInt ( 5000 ));
        } catch ( InterruptedException e ) {
            e . printStackTrace ();
        }
        return data ;
    }
}

jpipe js

jpipe.core.js

 ; ( function ( root , factory ) {
    if ( typeof exports === 'object' ) {
        module . exports = exports = factory ( ) ;
    } else if ( typeof define === 'function' && define . amd ) {
        define ( [ ] , factory ) ;
    } else {
        root . JP = factory ( ) ;
    }
} ( this , function ( ) {
    var JP = JP || ( function ( window ) {
        return {
            view : function ( json ) {
                var id = json [ 'id' ] ;
                document . getElementById ( id ) . innerHTML = json [ 'html' ] ;
            }
        } ;
    } ( window ) ) ;
    return JP ;
} ) ) ;

JSP Tags

Introduce tag <%@ taglib prefix="jp" uri="http://java.yl-online.top/jsp/jpipe" %>
Use custom tags, it is best to put them on </body> so that the rendering of the first screen dom will not be blocked.

 < %@ page contentType="text/html;charset=UTF-8" trimDirectiveWhitespaces="true" % >
< %@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" % >
< %@ taglib prefix="jp" uri="http://java.yl-online.top/jsp/jpipe" % >
< c:set var =" ctx " value =" ${pageContext.request.contextPath} " />
< html lang =" en " >
< head >
    < title > index </ title >
    < meta http-equiv =" Content-Type " content =" text/html; charset=UTF-8 " />
    < meta name =" viewport " content =" width=device-width,initial-scale=1.0,maximum-scale=1.0,user-scalable=no " >
    < script type =" text/javascript " src =" ${ctx}/resources/jpipe.core.js " > </ script >
</ head >
< body >
< h1 > index </ h1 >
< div id =" pagelet1 " > </ div >
< div id =" pagelet2 " > </ div >
< jp:pipe >
    < jp:pagelet domid =" pagelet1 " bean =" testPagelet1 " var =" item " uri =" id=123&name=forever杨" >
        < h1 > jspbody support </ h1 >
        < p > ${item.id} </ p >
    </ jp:pagelet >
    < jp:pagelet domid =" pagelet2 " bean =" testPagelet2 " var =" item2 " uri =" id=456&name=forever杨2 " >
        < h1 > jspbody support </ h1 >
        < p > ${item2.name} </ p >
    </ jp:pagelet >
</ jp:pipe >
</ body >
</ html >

No: Deploy to containers such as Tomcat and Jetty

FTL command

Configure namespaces through freemarker Configuration

 @ Configuration
public class MvcWevConfig {
    @ Resource
    private freemarker . template . Configuration configuration ;

    @ PostConstruct
    public void setConfiguration () {
        Version version = freemarker . template . Configuration . getVersion ();
        DefaultObjectWrapper wrapper = new DefaultObjectWrapperBuilder ( version ). build ();
        this . configuration . setSharedVariable ( "jp" , new FmHashModel ( wrapper ));
    }
}

 < #-- < #assign pipe="top.ylonline.jpipe.freemarker.tag.PipeTag"?new() /> -- >
< #-- < #assign pagelet="top.ylonline.jpipe.freemarker.tag.PageletTag"?new() /> -- >
< html lang =" en " >
< head >
    < title > index </ title >
    < meta http-equiv =" Content-Type " content =" text/html; charset=UTF-8 " />
    < meta name =" viewport " content =" width=device-width,initial-scale=1.0,maximum-scale=1.0,user-scalable=no " >
    < script type =" text/javascript " src =" jpipe.core.js " > </ script >
</ head >
< body >
< h1 > index </ h1 >
< div id =" pagelet1 " > </ div >
< div id =" pagelet2 " > </ div >
< @jp.pipe >
    < @jp.pagelet domid="pagelet1" bean="testPagelet1" var="item" uri="id=123&name=forever杨" >
        < h1 > testPagelet1 jspbody support </ h1 >
        < p > ${item.id} </ p >
    </ @jp.pagelet >
    < @jp.pagelet domid="pagelet2" bean="testPagelet2" var="item2" uri="id=456&name=forever杨2" >
        < h1 > testPagelet2 jspbody support </ h1 >
        < p > ${item2.name} </ p >
    </ @jp.pagelet >
</ @jp.pipe >
</ body >
</ html >

Configure via the assign command

 < #assign pipe="top.ylonline.jpipe.freemarker.tag.PipeTag"?new() />
< #assign pagelet="top.ylonline.jpipe.freemarker.tag.PageletTag"?new() />
< html lang =" en " >
< head >
    < title > index </ title >
    < meta http-equiv =" Content-Type " content =" text/html; charset=UTF-8 " />
    < meta name =" viewport " content =" width=device-width,initial-scale=1.0,maximum-scale=1.0,user-scalable=no " >
    < script type =" text/javascript " src =" jpipe.core.js " > </ script >
</ head >
< body >
< h1 > index </ h1 >
< div id =" pagelet1 " > </ div >
< div id =" pagelet2 " > </ div >
< @jp.pipe >
    < @jp.pagelet domid="pagelet1" bean="testPagelet1" var="item" uri="id=123&name=forever杨" >
        < h1 > testPagelet1 jspbody support </ h1 >
        < p > ${item.id} </ p >
    </ @jp.pagelet >
    < @jp.pagelet domid="pagelet2" bean="testPagelet2" var="item2" uri="id=456&name=forever杨2" >
        < h1 > testPagelet2 jspbody support </ h1 >
        < p > ${item2.name} </ p >
    </ @jp.pagelet >
</ @jp.pipe >
</ body >
</ html >

Using custom JSP tags in FTL

FTL supports the use of JSP tags. If your project does not use JSP templates, this is not recommended. Because custom JSP tags are written and operated in the JSP environment, Servlet containers that support JSP 1.1 or JSP 1.2 need to be introduced (Servlet container deployments such as Tomcat and Jetty), and FTL can be used in non-Servlet and other web environments.

A more accurate explanation is: although the Servlet container does not have local JSP support, you can also use the JSP tag library in FreeMarker. Just make sure that the javax.servlet.jsp.* package for JSP version 1.2 (or newer) is available in the web application. If your servlet container only supports JSP 1.1, then you have to copy the following six classes (such as you can extract from the jar package of Tomcat 5.x or Tomcat 4.x) to the WEB-INF/classes/... directory of the web application: javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.TryCatchFinally, javax.servlet.ServletContextListener, javax.servlet.ServletContextAttributeListener, javax.servlet.http.HttpSessionAttributeListener, javax.servlet.http.HttpSessionListener. However, be aware that because the container only supports JSP 1.1, usually using earlier versions before Servlet 2.3, event listeners may not be supported, so the JSP 1.2 tag library to register event listeners will work normally.

As of press time: JSP has been released to version 2.3

index.ftl code

Use <#assign jp=JspTaglibs["http://java.yl-online.top/jsp/jpipe"] /> to introduce custom JSP tags

 < #assign jp=JspTaglibs["http://java.yl-online.top/jsp/jpipe"] />
< html lang =" en " >
< head >
    < title > index </ title >
    < meta http-equiv =" Content-Type " content =" text/html; charset=UTF-8 " />
    < meta name =" viewport " content =" width=device-width,initial-scale=1.0,maximum-scale=1.0,user-scalable=no " >
    < script type =" text/javascript " src =" jpipe.core.js " > </ script >
</ head >
< body >
< h1 > index </ h1 >
< div id =" pagelet1 " > </ div >
< div id =" pagelet2 " > </ div >
< @jp.pipe >
    < @jp.pagelet domid="pagelet1" bean="testPagelet1" var="item" uri="id=123&name=forever杨" >
        < h1 > testPagelet1 support </ h1 >
        < p > ${item.id} </ p >
    </ @jp.pagelet >
    < @jp.pagelet domid="pagelet2" bean="testPagelet2" var="item2" uri="id=456&name=forever杨2" >
        < h1 > testPagelet2 support </ h1 >
        < p > ${item2.name} </ p >
    </ @jp.pagelet >
</ @jp.pipe >
</ body >
</ html >

Deploy to undertow

maven dependency

 <!-- undertow 部署 -->
< dependency >
    < groupId >org.springframework.boot</ groupId >
    < artifactId >spring-boot-starter-undertow</ artifactId >
</ dependency >
<!-- undertow 部署 -->

< dependency >
    < groupId >javax.servlet.jsp</ groupId >
    < artifactId >javax.servlet.jsp-api</ artifactId >
    < version >2.3.3</ version >
</ dependency >

Since containers such as undertow do not have a jsp-api environment, they need to rely on the javax.servlet.jsp-api package, and at the same time, they need to configure the classpathTlds of freemarker through TaglibFactory. Without this configuration, an error will be reported: freemarker.ext.jsp.TaglibFactory$TaglibGettingException: No TLD was found for the "http://java.yl-online.top/jsp/jpipe" JSP taglib URI. (TLD-s are searched according to the JSP 2.2 specification. In development- and embedded-servlet-container settings you may also need the "MetaInfTldSources" and "ClasspathTlds" freemarker.ext.servlet.FreemarkerServlet init-params or the similar system properties.)

Configuration

 @ Configuration
public class MvcWevConfig {
    @ Resource
    private FreeMarkerConfigurer freeMarkerConfigurer ;

    @ PostConstruct
    public void loadClassPathTlds () {
        List < String > classpathTlds = new ArrayList <>();
        classpathTlds . add ( "/META-INF/Jpipe.tld" );
        freeMarkerConfigurer . getTaglibFactory (). setClasspathTlds ( classpathTlds );
    }
}

Deploy to Tomcat

maven dependency

 <!-- 外部 Tomcat 部署 -->
< dependency >
    < groupId >javax.servlet</ groupId >
    < artifactId >javax.servlet-api</ artifactId >
    < scope >provided</ scope >
</ dependency >
< dependency >
    < groupId >org.springframework.boot</ groupId >
    < artifactId >spring-boot-starter-tomcat</ artifactId >
    < scope >provided</ scope >
</ dependency >
< dependency >
    < groupId >org.apache.tomcat.embed</ groupId >
    < artifactId >tomcat-embed-jasper</ artifactId >
    < scope >provided</ scope >
</ dependency >
<!-- 外部 Tomcat 部署 -->