sinlda/aurora

Aurora - Symfony 7.1 扩展包

维护者

详细信息

github.com/SindlaXYZ/Aurora

主页

源代码

问题

安装次数: 2,489

依赖者: 0

建议者: 1

安全: 0

星级: 0

关注者: 1

分支: 0

开放问题: 1

类型:symfony-bundle

v7.1.2 2024-09-12 04:46 UTC

Requires

Suggests

MIT 4a03308c1e2c0755ff2d37f8094b7eaae21cbfbe

  • Sindla XYZ S.R.L.

This package is auto-updated.

Last update: 2024-09-12 04:48:15 UTC

README

安装

Aurora 扩展包已准备好 Packagist，可以使用 Composer 进行安装。

composer require sindla/aurora:7.1.*

可以使用 x-dev 标志安装开发版本

composer require sindla/aurora:7.1.x-dev

配置

尽管 Aurora 已准备好 Packagist 并是 Symfony 扩展包，但不会自动安装任何配置

🗂️ config/packages/aurora.yaml
  • 创建文件 config/packages/aurora.yaml 并添加以下内容
parameters:
    aurora.bundle: 'App'
    aurora.root: '%kernel.project_dir%'
    aurora.tmp: '%kernel.project_dir%/var/tmp'
    aurora.resources: '%kernel.project_dir%/var/resources'
    aurora.static: '%kernel.project_dir%/public/static'
    aurora.locales: [ 'en', 'ro' ]
    aurora.locale: 'ro'
    # maxmind.com license key
    aurora.maxmind.license_key: '%env(default::MAXMIND_LICENSE_KEY)%'
    # Minify output
    aurora.minify.output: false
    aurora.minify.output.ignore.extensions: [ '.pdf', '.jpg', '.png', '.gif', '.doc' ]
    aurora.minify.output.ignore.content.type: [ 'text/plain' ]
    # https://developers.google.com/web/fundamentals/web-app-manifest
    #aurora.pwa.version_append:        "!php/eval `date('Y-m-d H')`"
    aurora.pwa.enabled:                 '%env(default:true:bool:AURORA_PWA_ENABLED)%'
    aurora.pwa.debug:                   '%env(default:true:bool:AURORA_PWA_DEBUG)%'
    aurora.pwa.version_append: "!php/eval `App\Utils::pwaVersioAppend()`"
    aurora.pwa.automatically_prompt: false
    aurora.pwa.app_name: ''
    aurora.pwa.app_short_name: ''
    aurora.pwa.app_description: ''
    aurora.pwa.start_url: '/?pwa'
    aurora.pwa.display: 'fullscreen'   # fullscreen | standalone | minimal-ui
    aurora.pwa.icons: '%kernel.project_dir%/public/static/img/favicon'
    aurora.pwa.theme_color: '#2C3E50' # Sets the color of the tool bar, and may be reflected in the app's preview in task switchers
    aurora.pwa.background_color: '#2C3E50' # Should be the same color as the load page, to provide a smooth transition from the splash screen to your app
    aurora.pwa.offline: '/aurora/pwa-offline'
    aurora.pwa.precache:
        - '/'
    aurora.pwa.prevent_cache_header_request_accept:
        - 'text/html'
        - 'text/html; charset=UTF-8'
        - 'application/json'
    aurora.pwa.prevent_cache:
        - '/ajax-requests'
        - '/q'
        - '/xhr'
        - '/login'
        - '/logout'
        - '/admin'
        - '.*\.mp4' # mp4 files are large, some browsers will not be able to fully cache it, meaning the video will not be displayed
        - '.*\/match-this\/.*'
    aurora.pwa.external_cache:
        - 'fonts.gstatic.com'
        - 'fonts.googleapis.com'
    aurora.dns_prefetch:
        - 'www.google.com'
        - 'fonts.googleapis.com'
        - 'fonts.gstatic.com'
        - 'googletagmanager.com'
        - 'www.googletagmanager.com'
        - 'www.google-analytics.com'
        - 'google-analytics.com'
        - 'googleads.g.doubleclick.net'
        - 'www.googletagservices.com'
        - 'adservice.google.com'
        - 'adservice.google.ro'
        - 'www.facebook.com'
        - 'gstatic.com'
        - 'www.gstatic.com'
        - 'google.com'
        - 'google.ro'
        - 'connect.facebook.net'
        - 'youtube.com'
        - 'addthis.com'
        - 'gemius.pl'
        - 'pubmatic.com'
        - 'innovid.com'
        - 'everesttech.net'
        - 'quantserve.com'
        - 'rubiconproject.com'
        - 'facebook.com'
        - 'agkn.com'
        - 'casalemedia.com'

🗂️ config/packages/dev/aurora.yaml
  • 创建文件 config/packages/dev/aurora.yaml 并添加以下内容
parameters:
    aurora.minify.output: false

🗂️ composer.json
  • 编辑 composer.json 并添加以下内容
    "post-install-cmd": [
"Sindla\\Bundle\\AuroraBundle\\Composer\\ScriptHandler::postInstall"
],
"post-update-cmd": [
"Sindla\\Bundle\\AuroraBundle\\Composer\\ScriptHandler::postUpdate"
]

🗂️ config/packages/twig.yaml
  • 编辑 config/packages/twig.yaml 并添加以下内容
twig:
    default_path: '%kernel.project_dir%/templates'
    debug: '%kernel.debug%'
    strict_variables: '%kernel.debug%'
    exception_controller: ~
    paths:
        '%kernel.project_dir%/vendor/sindla/aurora/src/templates': Aurora
    globals:
        aurora: '@aurora.twig.utility'

🗂️ config/routes.yaml
  • 将启用 Aurora 黑洞，Favicons，Manifest & PWA (渐进式网络应用) 控制器
  • 编辑 config/routes.yaml 并添加以下内容
aurora:
    resource: "@AuroraBundle/Resources/config/routes/routes.yaml"

然后运行 composer update 以更新和安装其他依赖。

⚙️ 渐进式网络应用
  • 要使用渐进式网络应用 (PWA)，请编辑您的 Twig 模板，并在 <head> 和 </head> 之间添加以下内容
{{ aurora.pwa(app.request) }}

⚙️ HTML 压缩器
  • 要启用 HTML 压缩器，请编辑 config/packages/aurora.yaml 并将 aurora.minify.output 更改为 true，然后编辑 config/services.yaml 并添加以下内容
    Sindla\Bundle\AuroraBundle\EventSubscriber\OutputSubscriber:
        arguments:
            $container: '@service_container'
            $utilityExtension: '@aurora.twig.utility'
              #$headers:
              #text/html:
              #Strict-Transport-Security: "max-age=1536000; includeSubDomains"
            #Content-Security-Policy: "default-src 'self'"
            # ?aurora.nonce? will be replace with uniq nonce. for twig, use {{ aurora.nonce() }}
            #Content-Security-Policy: "script-src 'nonce-?aurora.nonce?' 'unsafe-inline' 'unsafe-eval' 'strict-dynamic' https: http:; object-src 'none'"
            #Content-Security-Policy: "script-src 'self' 'unsafe-inline' 'unsafe-eval' https: http:; object-src 'none'"
            #Referrer-Policy: "no-referrer-when-downgrade"
        tags:
            - { name: kernel.event_listener, event: kernel.response }

⚙️ MaxMind GeoLite2Country & GeoLite2City
  • 当使用 composer install 和/或 composer update 时，Aurora 将尝试自动下载 MaxMind GeoLite2Country & GeoLite2City
  • 要启用此功能，请编辑您的 .env.local 并添加以下内容（您需要一个 MaxMind 许可证密钥）
MAXMIND_LICENSE_KEY=_CHANGE_THIS_WITH_YOUR_PRIVATE_LICENTE_KEY_
SINDLA_AURORA_GEO_LITE2_COUNTRY=true
SINDLA_AURORA_GEO_LITE2_CITY=true
  • 编辑 config/services.yaml 并添加以下内容
services:
    _defaults:
        bind:
            $auroraClient: '@aurora.client'
  • 或编辑 config/services.yaml 并添加以下代码以仅将 @aurora.client 注入所需的位置
services:
    App\Controller\TestController:
        arguments:
            $auroraClient: '@aurora.client'
  • 编辑您的控制器并添加以下代码
<?php

namespace App\Controller;

use Sindla\Bundle\AuroraBundle\Utils\AuroraClient\Client;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\Cache;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

#[Route('/test-controller')]
final class TestController extends AbstractController
{
    public function __construct(
        protected Client $auroraClient
    )
    {
    }

    #[Route(path: '/client-ip-2-country', name: 'TestController:clientIp2Country', methods: ['OPTIONS', 'GET'])]
    #[Cache(maxage: 60, smaxage: 120, public: true, mustRevalidate: true)]
    public function clientIp2Country(Request $request): JsonResponse
    {
        return new JsonResponse([
            'countryCode' => $this->auroraClient->ip2CountryCode($this->auroraClient->ip($request))
        ]);
    }
}

将 ContainerAwareInterface 注入到 Doctrine 迁移中

  1. config/services.yaml
    ...

    ###################################################################################################################
    ### Doctrine Migration ############################################################################################
    ### Inject Container into migrations; also, check doctrine_migrations.yaml > Doctrine\Migrations\Version\MigrationFactory

    Doctrine\Migrations\Version\DbalMigrationFactory: ~
    Sindla\Bundle\AuroraBundle\Doctrine\Migrations\Factory\MigrationFactoryDecorator:
        decorates: Doctrine\Migrations\Version\DbalMigrationFactory
        arguments: [ '@Sindla\Bundle\AuroraBundle\Doctrine\Migrations\Factory\MigrationFactoryDecorator.inner', '@service_container' ]

        ...
  1. config/packages/doctrine_migrations.yaml
doctrine_migrations:
    services:
        'Doctrine\Migrations\Version\MigrationFactory': 'Sindla\Bundle\AuroraBundle\Doctrine\Migrations\Factory\MigrationFactoryDecorator'
    ...