包简介

Packege for rendering JavaScript in Laravel application

README 文档

README

This helper allows you to render the SPA using node js for search bots.

Installation

To get the latest version of Laravel Server Side Rendering package, simply require the project using Composer:

composer require isakzhanov-r/laravel-ssr

Instead, you can, of course, manually update the dependency block require in composer.json and run composer update if you want to:

{
    "require": {
        "isakzhanov-r/laravel-ssr": "^1.0"
    }
}

If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php:

IsakzhanovR\Ssr\ServiceProvider::class;

Configuration

The package is configured to use node, since it is probably already installed on your system. If you need to change the configuration file you can publish it for modification (ie. interface to specific class):

php artisan vendor:publish --provider="IsakzhanovR\Ssr\ServiceProvider"

The configuration file contains two settings: the path where temporary files will be saved by default "storage/app/ssr" and the path to the node executable file

return [
    'temp_storage' => [
        'disk' => 'local', // filesystem disk
        'path' => 'ssr',   // directory
    ],
    'node_path'    => env('NODE_PATH', ''), // default /usr/bin/node
];

You can check on the server where the node is located by running the which node command and add the NODE_PATH key to the environment file

Usage

You will need two files for two scenarios: server and client. There is an example of a server script in the tests folder

mix
    .js('resources/js/server.js', 'public/js')
    .js('resources/js/client.js', 'public/js');

The server script must be passed to the ssr function, and the client script must be loaded manually. The package assumes that you are using Laravel Mix, and will resolve the path for you. I use as follows:

@section('content')
    {!! ssr()
            ->entry('js/server.js')
            ->fallback('<div id="wrapper" class="wrapper"></div>')
            ->setData(compact('titles'))
            ->render()  !!}
@endsection

@section('scripts')
    <script src="{{ mix('js/client.js') }}" defer></script>
@endsection

###Methods The entry() method takes the path to the server file argument.js, you can also pass the file path to the ssr() method

{!! ssr('js/server.js') !!}  ===  {!! ssr()->entry('js/server.js') !!}

The fallback() method is required if there are errors in the production process during rendering, this method will return the div to which the client application will be mounted.

The setData() method is required for transferring data to the server.js takes an array as an argument.

The render () method renders html from a js file ###Examples Example index blade

<html>
    <head>
        <title>My server side rendered app</title>
        <script defer src="{{ mix('client.js') }}">
    </head>
    <body>
        {!!
        ssr(mix('server.js'))
        ->setData(compact('news','posts'))
        ->render()
        !!}
    </body>
</html>

Example app.js

import Vue from 'vue';
import store from './store/index';
import router from './routes/index';
import App from './components/App';

export default new Vue({
    store,
    router,
    render: h => h(App)
});

Example server.js

import app from './app';
import renderVueComponentToString from 'vue-server-renderer/basic';

app.$store.commit('SetNews', {news: news});
app.$store.commit('SetPosts', {posts: posts});

app.$router.push(url.path);

renderVueComponentToString(app, (err, html) => {
    if (err) {
        throw new Error(err);
    }
    dispatch(html);
});

Example client.js

import app from './app';
import './../vue-client/plugins/bootstrap';

app.$store.commit('SetNews', {news: news});
app.$store.commit('SetPosts', {posts: posts});

app.$mount('#wrapper');

Try to include all plugins and packages that can use the window object in the client.js file because when rendering the server file, node will not find the window object and will return an error.

##License This package is released under the MIT License.

isakzhanov-r/laravel-ssr 适用场景与选型建议

isakzhanov-r/laravel-ssr 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 5.37k 次下载、GitHub Stars 达 7，最近一次更新时间为 2020 年 03 月 03 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「laravel」「SSR」「server side rendering」「server side rendering node」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 isakzhanov-r/laravel-ssr 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 isakzhanov-r/laravel-ssr 我们能提供哪些服务？

定制开发 / 二次开发

基于 isakzhanov-r/laravel-ssr 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 isakzhanov-r/laravel-ssr 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

gener1c-code/oauth2-server 0

A lightweight and powerful OAuth 2.0 authorization and resource server library with support for all the core specification grants. This library will allow you to secure your API with OAuth and allow your applications users to approve apps that want to access their data from your API.

koriym/baracoa 12

A JavaScript server side rendering interface

irfa/php-gatcha 35

Simple Items Gatcha with PHP

stefangabos/zebra_form 96

A jQuery augmented PHP library for creating and validating HTML forms

esd/annotations-scan-plugin 2

annotations-scan-plugin

fernleafsystems/apiwrappers-serverpilot 0

ServerPilot: the best way to run PHP websites.