Larravel ` Http:: withUrlParameters ` Usage Author: Chuwen Time: 2023-07-18 Classification: Laravel , PHP comment <trans data-src="## 使用前">##Before use</trans> <trans data-src="在调用 HTTP API 时会发现有很多 API 都是采用 *REST API* 风格，例如：">When calling the HTTP API, you will find that many APIs adopt the * REST API * style, for example:</trans> <trans data-src="* /admin/api/2023-07/products/{product_id}.json">* /admin/api/2023-07/products/{product_id}.json</trans> <trans data-src="* /admin/api/2023-01/orders/{order_id}.json">* /admin/api/2023-01/orders/{order_id}.json</trans> <trans data-src="* /admin/api/2023-01/orders/{order_id}/fulfillments/{fulfillment_id}.json">* /admin/api/2023-01/orders/{order_id}/fulfillments/{fulfillment_id}.json</trans> <trans data-src="* ...">* ...</trans> <trans data-src="不难发现它们都有一个共同点，以花括号（`{var_name}`、`{order_id}`）包裹的变量替换为对应的值，通常我们可能会这么做：">It is not difficult to find that they all have one thing in common. They are replaced with corresponding values by variables wrapped in curly braces ('{var_name}', '{order_id}'). Usually, we may do this:</trans> <trans data-src="```php">```php</trans> <trans data-src="$http = \Illuminate\Support\Facades\Http::baseUrl('">$http = \Illuminate\Support\Facades\Http::baseUrl('</trans> <trans data-src="https://example.com">https://example.com</trans> <trans data-src="');">');</trans> <trans data-src="$order_id = 123456789;">$order_id = 123456789;</trans> <trans data-src="$fulfillment_id = 9889894445;">$fulfillment_id = 9889894445;</trans> <trans data-src="$orderUrl = sprintf('/admin/api/2023-07/orders/%d.json', $product_id);">$orderUrl = sprintf('/admin/api/2023-07/orders/%d.json', $product_id);</trans> <trans data-src="$fulfillmentUrl = sprintf('/admin/api/2023-01/orders/%d/fulfillments/%d.json', $order_id, $fulfillment_id);">$fulfillmentUrl = sprintf('/admin/api/2023-01/orders/%d/fulfillments/%d.json', $order_id, $fulfillment_id);</trans> <trans data-src="$order = $http->get($orderUrl);">$order = $http->get($orderUrl);</trans> <trans data-src="$fulfillment = $http->get($fulfillmentUrl);">$fulfillment = $http->get($fulfillmentUrl);</trans> <trans data-src="```">```</trans> <trans data-src="但是会发现这样拼接 URI 会很繁琐">However, it will be tedious to splice URIs like this</trans> <trans data-src="## 使用后 - `Http::withUrlParameters`">##After use - ` Http:: withUrlParameters`</trans> <trans data-src="```php">```php</trans> <trans data-src="$http = \Illuminate\Support\Facades\Http::baseUrl('">$http = \Illuminate\Support\Facades\Http::baseUrl('</trans> <trans data-src="https://example.com">https://example.com</trans> <trans data-src="')">')</trans> <trans data-src="->withUrlParameters([">->withUrlParameters([</trans> <trans data-src="'order_id' => 123456789,">'order_id' => 123456789,</trans> <trans data-src="'fulfillment_id' => 9889894445">'fulfillment_id' => 9889894445</trans> <trans data-src="]);">]);</trans> <trans data-src="// 比如你要使用上述定义 URL 参数：order_id">//For example, you need to use the above URL parameter: order_id</trans> <trans data-src="// 你在 URL 只需要填 {order_id}">//You only need to fill in {order_id} in the URL</trans> <trans data-src="// 在请求时会自动替换">//Automatically replace when requested</trans> <trans data-src="$orderUrl = '/admin/api/2023-07/orders/{order_id}.json';">$orderUrl = '/admin/api/2023-07/orders/{order_id}.json';</trans> <trans data-src="$fulfillmentUrl = '/admin/api/2023-01/orders/{orders_id}/fulfillments/{fulfillment_id}.json';">$fulfillmentUrl = '/admin/api/2023-01/orders/{orders_id}/fulfillments/{fulfillment_id}.json';</trans> <trans data-src="$order = $http->get($orderUrl);">$order = $http->get($orderUrl);</trans> <trans data-src="$fulfillment = $http->get($fulfillmentUrl);">$fulfillment = $http->get($fulfillmentUrl);</trans> <trans data-src="```">```</trans> <trans data-src="会发现使用会很方便，不需要再使用如 `sprintf` 去拼接 URL 了">You will find it convenient to use, and you don't need to use "sprintf" to splice URLs</trans>
Larravel Model relationships Query does not find a value Return default value Author: Chuwen Time: 2023-05-29 Classification: Laravel comment <trans data-src="## Laravel 模型关联查询未找到值返回默认值">##Laravel model association query does not find a value, and the default value is returned</trans> <trans data-src="在实际业务中，经常会用到模型关联查询，但是有时候关联的那个模型在数据库中不存在，则会返回 null，如果你再去判断是否为 null 逻辑就很复杂，下面给出一个现实中的常见一个例子">In actual business, model association queries are often used, but sometimes the associated model does not exist in the database, and null will be returned. If you judge whether it is null, the logic is complex. Here is a common example in reality</trans> <trans data-src="假设有 2 个模型，`User::class` 和 `UserConfig::class`">Suppose there are two models, 'User:: class' and' UserConfig:: class`</trans> <trans data-src="**User::class**">**User::class**</trans> <trans data-src="```php">```php</trans> <trans data-src="<?"><?</trans> <trans data-src="php">php</trans> <trans data-src="namespace App\Models;">namespace App\Models;</trans> <trans data-src="/**">/**</trans> <trans data-src="* \App\Models\User">* \App\Models\User</trans> <trans data-src="*">*</trans> <trans data-src="* @property int $id">* @property int $id</trans> <trans data-src="* @property string $username">* @property string $username</trans> <trans data-src="* ... ">* ... </trans> <trans data-src="省略部分属性">Omit some attributes</trans> <trans data-src="* ">* </trans> <trans data-src="* @property-read \App\Models\UserConfig|null $config">* @property-read \App\Models\UserConfig|null $config</trans> <trans data-src="*/">*/</trans> <trans data-src="class User extends Model">class User extends Model</trans> <trans data-src="{">{</trans> <trans data-src="protected $table = "users";">protected $table = "users";</trans> <trans data-src="public function config()">public function config()</trans> <trans data-src="{">{</trans> <trans data-src="return $this->hasOne(\App\Models\UserConfig::class, 'uid', 'id');">return $this->hasOne(\App\Models\UserConfig::class, 'uid', 'id');</trans> <trans data-src="}">}</trans> <trans data-src="}">}</trans> <trans data-src="```">```</trans> <trans data-src="**UserConfig::class**">**UserConfig::class**</trans> <trans data-src="```php">```php</trans> <trans data-src="<?"><?</trans> <trans data-src="php">php</trans> <trans data-src="namespace App\Models;">namespace App\Models;</trans> <trans data-src="/**">/**</trans> <trans data-src="* \App\Models\UserConfig">* \App\Models\UserConfig</trans> <trans data-src="*">*</trans> <trans data-src="* @property int $id">* @property int $id</trans> <trans data-src="* @property int $uid">* @property int $uid</trans> <trans data-src="* @property array $locales">* @property array $locales</trans> <trans data-src="* ... ">* ... </trans> <trans data-src="省略部分属性">Omit some attributes</trans> <trans data-src="*/">*/</trans> <trans data-src="class UserConfig extends Model">class UserConfig extends Model</trans> <trans data-src="{">{</trans> <trans data-src="protected $table = "config";">protected $table = "config";</trans> <trans data-src="}">}</trans> <trans data-src="```">```</trans> <trans data-src="示例代码：">Sample code:</trans> <trans data-src="```php">```php</trans> <trans data-src="$uid = 1;">$uid = 1;</trans> <trans data-src="$userM = User::findOrFail($uid);">$userM = User::findOrFail($uid);</trans> <trans data-src="return [">return [</trans> <trans data-src="// 如果关联的 config 模型查找不到值，就会报错">//If the associated config model cannot find a value, an error will be reported</trans> <trans data-src="'locales' => $userM->config->locales">'locales' => $userM->config->locales</trans> <trans data-src="];">];</trans> <trans data-src="```">```</trans> <trans data-src="## 解决方法">##Solution</trans> <trans data-src="[翻阅文档](">[Flipping through documents]（</trans> <trans data-src="https://laravel.com/docs/10.x/eloquent-relationships#default">https://laravel.com/docs/10.x/eloquent-relationships#default</trans> <trans data-src="-models)发现有这样一个方法 `withDefault()`">-Models) found such a method ` withDefault()`</trans> <trans data-src="官方文档的解释：">Interpretation of official documents:</trans> <trans data-src="> The belongsTo, hasOne, hasOneThrough, and morphOne relationships allow you to define a default model that will be returned if the given relationship is null. ">> The belongsTo, hasOne, hasOneThrough, and morphOne relationships allow you to define a default model that will be returned if the given relationship is null. </trans> <trans data-src="This pattern is often referred to as the Null Object pattern and can help remove conditional checks in your code. ">This pattern is often referred to as the Null Object pattern and can help remove conditional checks in your code. </trans> <trans data-src="In the following example, the user relation will return an empty App\Models\User model if no user is attached to the Post model:">In the following example, the user relation will return an empty App\Models\User model if no user is attached to the Post model:</trans> <trans data-src="> ">> </trans> <trans data-src="> 机器翻译成中文：">>Machine translation into Chinese:</trans> <trans data-src="> ">> </trans> <trans data-src=">> 如果给定的关系为空，则可以定义默认模型。">>>If the given relationship is empty, you can define a default model.</trans> <trans data-src="这种模式通常称为 `空对象模式`，可以帮助删除代码中的条件检查。">This mode is usually called 'empty object mode', which can help delete condition checks in code.</trans> <trans data-src="在以下示例中，如果没有用户附加到Post模型，用户关系将返回一个空的App\Models\User模型：">In the following example, if no user is attached to the Post model, the user relationship will return an empty App Models User model:</trans> <trans data-src="用法很简单，只需要在 `hasOne` 末尾加上 `->withDefault()` 方法，然后在 `UserConfig::class` 的 `$attributes` 属性写上默认值即可">The usage is simple. Just add the method '->withDefault()' at the end of 'hasOne', and then write the default value in the '$attributes' attribute of' UserConfig:: class'</trans> <trans data-src="**User::class**">**User::class**</trans> <trans data-src="```php">```php</trans> <trans data-src="<?"><?</trans> <trans data-src="php">php</trans> <trans data-src="namespace App\Models\Admin;">namespace App\Models\Admin;</trans> <trans data-src="/**">/**</trans> <trans data-src="* \App\Models\User">* \App\Models\User</trans> <trans data-src="*">*</trans> <trans data-src="* @property int $id">* @property int $id</trans> <trans data-src="* @property string $username">* @property string $username</trans> <trans data-src="* ... ">* ... </trans> <trans data-src="省略部分属性">Omit some attributes</trans> <trans data-src="* ">* </trans> <trans data-src="* @property-read \App\Models\UserConfig|null $config">* @property-read \App\Models\UserConfig|null $config</trans> <trans data-src="*/">*/</trans> <trans data-src="class User extends Model">class User extends Model</trans> <trans data-src="{">{</trans> <trans data-src="protected $table = "users";">protected $table = "users";</trans> <trans data-src="public function config()">public function config()</trans> <trans data-src="{">{</trans> <trans data-src="return $this->hasOne(\App\Models\UserConfig::class, 'uid', 'id')->withDefault();">return $this->hasOne(\App\Models\UserConfig::class, 'uid', 'id')->withDefault();</trans> <trans data-src="}">}</trans> <trans data-src="}">}</trans> <trans data-src="```">```</trans> <trans data-src="**UserConfig::class**">**UserConfig::class**</trans> <trans data-src="```php">```php</trans> <trans data-src="<?"><?</trans> <trans data-src="php">php</trans> <trans data-src="namespace App\Models;">namespace App\Models;</trans> <trans data-src="/**">/**</trans> <trans data-src="* \App\Models\UserConfig">* \App\Models\UserConfig</trans> <trans data-src="*">*</trans> <trans data-src="* @property int $id">* @property int $id</trans> <trans data-src="* @property int $uid">* @property int $uid</trans> <trans data-src="* @property array $locales">* @property array $locales</trans> <trans data-src="* ... ">* ... </trans> <trans data-src="省略部分属性">Omit some attributes</trans> <trans data-src="*/">*/</trans> <trans data-src="class UserConfig extends Model">class UserConfig extends Model</trans> <trans data-src="{">{</trans> <trans data-src="protected $table = "config";">protected $table = "config";</trans> <trans data-src="protected $attributes = [">protected $attributes = [</trans> <trans data-src="'locales' => ['en']">'locales' => ['en']</trans> <trans data-src="];">];</trans> <trans data-src="}">}</trans> <trans data-src="```">```</trans> <trans data-src="```php">```php</trans> <trans data-src="$uid = 1;">$uid = 1;</trans> <trans data-src="$userM = User::findOrFail($uid);">$userM = User::findOrFail($uid);</trans> <trans data-src="return [">return [</trans> <trans data-src="// 如果关联的 config 模型查找不到值，就会返回默认值 ['en']">//If the associated config model cannot find a value, the default value ['en '] will be returned</trans> <trans data-src="'locales' => $userM->config->locales">'locales' => $userM->config->locales</trans> <trans data-src="];">];</trans> <trans data-src="```">```</trans>
Larravel Model (model) implements table splitting query - a certain number of table splitting queries according to UID Author: Chuwen Time: 2023-04-28 Classification: Laravel , PHP comment <trans data-src="当业务达到一定量，一些表就可能需要用到分表、分库等方法，加快数据库查询速度，在 Laravel 中可以按照如下方式实现">When the business reaches a certain amount, some tables may need to be divided into tables, databases and other methods to speed up database queries, which can be implemented in Larravel as follows</trans> <trans data-src="### 代码实现如下">###The code implementation is as follows</trans> <trans data-src="```php">```php</trans> <trans data-src="<?"><?</trans> <trans data-src="php">php</trans> <trans data-src="namespace App\Models;">namespace App\Models;</trans> <trans data-src="use Illuminate\Database\Eloquent\Model;">use Illuminate\Database\Eloquent\Model;</trans> <trans data-src="class Orders extends Model">class Orders extends Model</trans> <trans data-src="{">{</trans> <trans data-src="protected $table = 'orders';">protected $table = 'orders';</trans> <trans data-src="/**">/**</trans> <trans data-src="* 获取分表名">*Get sub table name</trans> <trans data-src="*">*</trans> <trans data-src="* @param int $uid">* @param int $uid</trans> <trans data-src="* @param int $count 多少个用户分一次表，默认 10000 用户分一张表">*@ param int $count How many users divide a table? By default, 10000 users divide a table</trans> <trans data-src="* @return string">* @return string</trans> <trans data-src="*/">*/</trans> <trans data-src="public static function getPartitionedTableName(int $uid, int $count = 10000): string">public static function getPartitionedTableName(int $uid, int $count = 10000): string</trans> <trans data-src="{">{</trans> <trans data-src="$tableNum = ceil($uid / $count);">$tableNum = ceil($uid / $count);</trans> <trans data-src="return $this->table . ">return $this->table . </trans> <trans data-src=""_" . ">"_" . </trans> <trans data-src="(($tableNum - 1) * $count + 1) . ">(($tableNum - 1) * $count + 1) . </trans> <trans data-src=""_" . ">"_" . </trans> <trans data-src="($tableNum * $count);">($tableNum * $count);</trans> <trans data-src="}">}</trans> <trans data-src="public function scopeByUid($query, int $uid)">public function scopeByUid($query, int $uid)</trans> <trans data-src="{">{</trans> <trans data-src="return $query->from(self::getPartitionedTableName($uid))->where('uid', $uid);">return $query->from(self::getPartitionedTableName($uid))->where('uid', $uid);</trans> <trans data-src="}">}</trans> <trans data-src="}">}</trans> <trans data-src="```">```</trans> <trans data-src="### 使用方法">###Usage</trans> <trans data-src="```php">```php</trans> <trans data-src="// 查找的表是 orders_1_10000">//The table searched is orders_1_10000</trans> <trans data-src="Orders::byUid(4)->first();">Orders::byUid(4)->first();</trans> <trans data-src="// 查找的表是 orders_10001_20000">//The table searched is orders_10001_20000</trans> <trans data-src="Orders::byUid(20000)->first();">Orders::byUid(20000)->first();</trans> <trans data-src="```">```</trans>
Use PHPStorm advanced metadata Author: Chuwen Time: 2023-02-11 Classification: Laravel , PHP comment <trans data-src="## 例子 1">##Example 1</trans> <trans data-src="你通过 `$request->user()` 想拿到用户模型，但是没有类型提示很苦恼，你可以这样做">You want to get the user model through '$request ->user()', but it's very annoying that there is no type prompt. You can do this</trans> <trans data-src="在项目跟路径创建一个文件 `.phpstorm.meta.php`，然后里面的内容写：">Create a file '. phpstrom. meta. php' in the project and path, and then write:</trans> <trans data-src="```php">```php</trans> <trans data-src="<?"><?</trans> <trans data-src="php">php</trans> <trans data-src="// @formatter:off">// @formatter:off</trans> <trans data-src="namespace PHPSTORM_META {">namespace PHPSTORM_META {</trans> <trans data-src="// 定义输出类型">//Define Output Type</trans> <trans data-src="override(\Illuminate\Http\Request::user(), map([">override(\Illuminate\Http\Request::user(), map([</trans> <trans data-src="'' => \App\Models\User::class,">'' => \App\Models\User::class,</trans> <trans data-src="]));">]));</trans> <trans data-src="}">}</trans> <trans data-src="```">```</trans> <trans data-src="然后就会有类型提示了：">Then there will be a type prompt:</trans> <trans data-src="!">!</trans> <trans data-src="[](">[](</trans> <trans data-src="https://cdn.nowtime.cc/2023/02/10/1231715426.png">https://cdn.nowtime.cc/2023/02/10/1231715426.png</trans> <trans data-src=")">)</trans> <trans data-src="更多高级用法请看：">For more advanced usage, see:</trans> <trans data-src="https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html#map">https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html#map</trans>
Laravel obtains relevant values according to the Session ID Author: Chuwen Time: 2022-10-10 Classification: Laravel comment <trans data-src="## 背景">##Background</trans> <trans data-src="- 「A 系统」域名 `admin.xxxx.com` - 使用的是 Dcat Admin，Session 身份认证">-Domain name of System A 'admin. xxxx. com' - Dcat Admin, Session authentication is used</trans> <trans data-src="- 「A1 系统」域名 `api.sass.com` - 使用 JWT 身份认证">-A1 System domain name 'api. sass. com' - use JWT authentication</trans> <trans data-src="因为项目有个需求，需要从「A 系统」访问「A1 系统」，实际上是「A 系统」生成 JWT 传递给「A1 系统」，JWT 格式如下：">Because the project has a requirement, it needs to access the A1 system from the A system. In fact, the A system generates the JWT and transfers it to the A1 system. The JWT format is as follows:</trans> <trans data-src="> 使用 `sub` 标记是谁生成的，让「A1 系统」能够进行判断">>Use the 'sub' mark to mark who generated it, so that the A1 system can judge</trans> <trans data-src="!">!</trans> <trans data-src="[](">[](</trans> <trans data-src="https://cdn.nowtime.cc/2022/10/10/3948634876.png">https://cdn.nowtime.cc/2022/10/10/3948634876.png</trans> <trans data-src=")">)</trans> <trans data-src="需要实现「A 系统」退出登录，「A1 系统」的 JWT 信息就不能通过认证">If you need to log out of System A, the JWT information of System A1 cannot pass the authentication</trans> <trans data-src="因为这 2 个系统是共用一套代码的，所以想到了使用 `Session ID` 写入 JWT `payload` 中，然后「A1 系统」拿到 `Session ID` 去校验">Because the two systems share a set of codes, it is proposed to use the 'Session ID' to write into the JWT 'payload', and then the 'A1 System' gets the 'Session ID' to verify</trans> <trans data-src="## 实现">##Implementation</trans> <trans data-src="### 拿到 Laravel Session ID">###Get Laravel Session ID</trans> <trans data-src="「A 系统」通过 `Illuminate\Support\Facades\Session::getId()` 拿到长度为 40 的 `Session ID`，生成 JWT 传递给「A1 系统」使用">System A obtains a 40 length 'Session ID' through 'Illuminate Support Facades Session:: getId()', generates a JWT, and passes it to System A1 for use</trans> <trans data-src="!">!</trans> <trans data-src="[](">[](</trans> <trans data-src="https://cdn.nowtime.cc/2022/10/10/3680874563.png">https://cdn.nowtime.cc/2022/10/10/3680874563.png</trans> <trans data-src=")">)</trans> <trans data-src="### 「A1 系统」校验 Session ID 是否存在">###[A1 System] Verify whether the Session ID exists</trans> <trans data-src="示例代码如下：">The example code is as follows:</trans> <trans data-src="```php">```php</trans> <trans data-src="// 这里实际需要替换为从 JWT 解析，拿到 `session_id` 字段">//The actual need here is to parse from JWT and get the 'session_id' field</trans> <trans data-src="$sessionId = '';">$sessionId = '';</trans> <trans data-src="$data = Illuminate\Support\Facades\Session::getHandler()->read($sessionId);">$data = Illuminate\Support\Facades\Session::getHandler()->read($sessionId);</trans> <trans data-src="if(empty($data)){">if(empty($data)){</trans> <trans data-src="// TODO: SessionID 不存在，请检查">//TODO: SessionID does not exist, please check</trans> <trans data-src="}">}</trans> <trans data-src="```">```</trans>