jpipe下載 - jpipe源代碼下載

Jpipe

A Java implementation of Facebook's bigPipe technology.

Jpipe 是通過自定義標籤實現的，所以對後端代碼零侵入。

HTML 是完成前台頁面的功能，而自定義標籤可以在後台完成某些操作。

特性

jsp 標籤支持
freemarker 指令支持
freemarker 中使用jsp 標籤

為什麼使用BigPipe

解決速度瓶頸
降低延遲時間

BigPipe 適合什麼場景

主要適用於：

請求時間較長，後端程序需要讀取多個API獲取數據
頁面內容可以劃分成多個區塊顯示，且各個區塊之間的關聯不大（松耦合）
對SEO需求較弱

多種實現方式的對比

類型	請求數	服務器端壓力	用戶體驗	網頁加載速度	模塊加載順序	實現難度	後期維護難度
普通	1	小	差	慢	文檔流順序	簡單	一般
Ajax	多	大	好	快	不確定	困難	困難
單線程BigPipe	1	小	好	慢	自定義	一般	一般
多線程BigPipe	1	一般（線程池引起）	好	最快	不確定	最困難	一般

開始

線程池配置

屬性	類型	是否必填	缺省值	說明	描述
core-size	int	否	-1	核心線程數	最小空閒線程數，無論如何都會存活的最小線程數
max-size	int	否	1024	最大線程數	Jpipe 能創建用來處理pagelet 的最大線程數
queue-size	int	否	1024	最大等待對列數	請求並發大於max-size，則被放入隊列等待
keep-alive	long	否	60000	最大空閒時間(ms)	超過這個空閒時間，且線程數大於core-size 的，被回收直到線程數等於core-size
pre-start-all-core-threads	boolean	否	false	預熱線程池	是否預先啟動core-size 個線程

pepe 標籤、指令

屬性	類型	是否必填	缺省值	說明	描述
async	boolean	否	true	是否異步執行pagelet任務

pagelet 標籤、指令

屬性	類型	是否必填	缺省值	說明
domid	string	是		html document Id
bean	string	是		spring bean name
var	string	是		variable 參數
uri	string	否		uri 參數
jsmethod	string	否	JP.view	包裝數據的js函數

與Spring集成

通過JpipeThreadPoolFactoryBean類

<? 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 >

通過JpipeThreadPoolBuilder類

<? 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 >

通過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 ();
}

通過spring-boot starter

pom.xml 依賴

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

application.yml 配置

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

定義一個pagelet

使用Spring 的@Service定義一個pagelet，實現PageletBean 接口的doExec 方法

 @ 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 標籤

引入標籤<%@ taglib prefix="jp" uri="http://java.yl-online.top/jsp/jpipe" %>
使用自定義標籤，最好放到</body>上面，這樣就不會堵塞首屏dom的渲染

 < %@ 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 >

略：部署到Tomcat、Jetty 等容器

FTL 指令

通過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 >

通過assign 指令配置

 < #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 >

在FTL 中使用自定義JSP 標籤

FTL 是支持使用JSP 標籤的。如果你的項目本來沒有使用JSP 模版，不推薦這種使用做法。因為自定義JSP 標籤是在JSP 環境中來寫作操作的，需要引入支持JSP 1.1或者JSP 1.2的Servlet 容器（Tomcat、Jetty等Servlet容器部署），而FTL 可以在非Servlet 等Web 環境中使用。

更準確的解釋是：儘管Servlet 容器沒有本地的JSP支持，你也可以在FreeMarker 中使用JSP標籤庫。只是確保對JSP 1.2版本(或更新)的javax.servlet.jsp.* 包在Web應用程序中可用就行。如果你的servlet容器只對JSP 1.1支持，那麼你不得不將下面六個類(比如你可以從Tomcat 5.x或Tomcat 4.x的jar包中提取)複製到Web應用的WEB-INF/classes/...目錄下： javax.servlet.jsp.tagext.IterationTag， javax.servlet.jsp.tagext.TryCatchFinally， javax.servlet.ServletContextListener， javax.servlet.ServletContextAttributeListener， javax.servlet.http.HttpSessionAttributeListener， javax.servlet.http.HttpSessionListener。但是要注意，因為容器只支持JSP 1.1，通常是使用較早的Servlet 2.3之前的版本，事件監聽器可能就不支持，因此JSP 1.2標籤庫來註冊事件監聽器會正常工作。

截止發稿：JSP已經發佈到2.3版本

index.ftl 代碼

使用<#assign jp=JspTaglibs["http://java.yl-online.top/jsp/jpipe"] />引入自定義JSP 標籤

 < #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 >

部署到undertow

maven 依賴

 <!-- 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 >

由於undertow 等容器沒有jsp-api 環境，所以需要依賴javax.servlet.jsp-api 包，同時要通過TaglibFactory 配置freemarker 的classpathTlds。沒有這個配置，會報錯：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 the JSP 2.2 specification. In development- and embedded-servlet-container setups you may also need the "MetaInfTldSources" and "ClasspathTlds" freemarker.ext.servlet.FreemarkerServlet init-params or the similar system properites.)

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 );
    }
}

部署到Tomcat

maven 依賴

 <!-- 外部 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 部署 -->