format 格式化工具
17:43说明
$u.formatNumber、$u.formatName、$u.timeFormat、$u.padZero 分别处理数字、姓名、时间与补零四类格式化:数字默认去尾零并按需加千位分隔符,姓名按长度打码,时间按 token 替换,补零按总位数左补 0。
示例
数字格式化
覆盖默认去尾零、指定小数位、四舍五入取整、千位分隔与自定义小数点,第五个参数控制是否保留尾零。
查看源码
vue
<template>
<ux-cell-group :border="false">
<ux-cell-item
v-for="(item, index) in numberList"
:key="index"
:title="item.desc"
:value="item.result"
:arrow="false"
:border-bottom="!item.last"
/>
</ux-cell-group>
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
type Row = {
desc: string;
result: string;
last: boolean;
};
// 参数顺序:数字、小数位、小数点符号、千位分隔符、是否保留尾零
const numberList: Row[] = [
{ desc: '$u.formatNumber(1234)', result: $u.formatNumber(1234), last: false },
// 默认去尾零:虽然给了 2 位,结果仍是 1234
{ desc: '$u.formatNumber(1234, 2)', result: $u.formatNumber(1234, 2), last: false },
{ desc: '$u.formatNumber(1234.5678, 2)', result: $u.formatNumber(1234.5678, 2), last: false },
// 0 位即四舍五入取整
{ desc: "$u.formatNumber(5321.5, 0, '.', ',')", result: $u.formatNumber(5321.5, 0, '.', ','), last: false },
{ desc: "$u.formatNumber(1234567.891, 2, '.', ',')", result: $u.formatNumber(1234567.891, 2, '.', ','), last: false },
// 第五个参数传 true 保留尾零
{ desc: "$u.formatNumber(1234, 2, '.', ',', true)", result: $u.formatNumber(1234, 2, '.', ',', true), last: false },
// 自定义小数点与千位分隔符(欧式写法)
{ desc: "$u.formatNumber(1234.5, 2, ',', '.')", result: $u.formatNumber(1234.5, 2, ',', '.'), last: true }
];
</script>姓名打码
单字原样返回,两字保留首字,三字及以上保留首末字,空串仍返回空串。
查看源码
vue
<template>
<ux-cell-group :border="false">
<ux-cell-item
v-for="(item, index) in nameList"
:key="index"
:title="item.desc"
:value="item.result"
:arrow="false"
:border-bottom="!item.last"
/>
</ux-cell-group>
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
type Row = {
desc: string;
result: string;
last: boolean;
};
// 一字原样返回,两字保留首字,三字以上保留首末字
const nameList: Row[] = [
{ desc: '$u.formatName("张")', result: $u.formatName('张'), last: false },
{ desc: '$u.formatName("张三")', result: $u.formatName('张三'), last: false },
{ desc: '$u.formatName("欧阳修")', result: $u.formatName('欧阳修'), last: false },
{ desc: '$u.formatName("司马相如")', result: $u.formatName('司马相如'), last: false },
{ desc: '$u.formatName("")', result: $u.formatName(''), last: true }
];
</script>时间格式化
同一时间戳按不同模板输出,m 为月、M 为分,连续两位补零;10 位字符串按秒级时间戳处理。
查看源码
vue
<template>
<ux-cell-group :border="false">
<ux-cell-item
v-for="(item, index) in timeList"
:key="index"
:title="item.desc"
:value="item.result"
:arrow="false"
:border-bottom="!item.last"
/>
</ux-cell-group>
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
type Row = {
desc: string;
result: string;
last: boolean;
};
// token:y 年 / m 月 / d 日 / h 时 / M 分 / s 秒,注意 m 是月、M 是分
// 连续两位自动补零,单个字符不补零;结果随设备时区变化
const timeList: Row[] = [
{ desc: '$u.timeFormat(1700000000000)', result: $u.timeFormat(1700000000000), last: false },
{ desc: "$u.timeFormat(1700000000000, 'yyyy-mm-dd hh:MM:ss')", result: $u.timeFormat(1700000000000, 'yyyy-mm-dd hh:MM:ss'), last: false },
// 10 位字符串按秒级时间戳处理
{ desc: "$u.timeFormat('1700000000', 'yyyy-mm-dd')", result: $u.timeFormat('1700000000', 'yyyy-mm-dd'), last: false },
{ desc: "$u.timeFormat(1700000000000, 'yy-m-d h:M:s')", result: $u.timeFormat(1700000000000, 'yy-m-d h:M:s'), last: true }
];
</script>补零
padZero 按总位数左补 0,原数字更长时原样返回,小数会先被取整。
查看源码
vue
<template>
<ux-cell-group :border="false">
<ux-cell-item
v-for="(item, index) in padZeroList"
:key="index"
:title="item.desc"
:value="item.result"
:arrow="false"
:border-bottom="!item.last"
/>
</ux-cell-group>
</template>
<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';
type Row = {
desc: string;
result: string;
last: boolean;
};
// 第二参数为补零后的总位数,小数先被 Math.floor 取整
const padZeroList: Row[] = [
{ desc: '$u.padZero(5)', result: $u.padZero(5), last: false },
{ desc: '$u.padZero(5, 3)', result: $u.padZero(5, 3), last: false },
{ desc: '$u.padZero(123, 2)', result: $u.padZero(123, 2), last: false },
{ desc: '$u.padZero(7.9)', result: $u.padZero(7.9), last: true }
];
</script>API
formatNumber
参数:
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| num | 需要格式化的数字或数字字符串 | number | string | null | - | - |
| decimals | 显示的小数位数 | number | string | null | 0 | - |
| decimalPoint | 小数点符号 | number | string | null | '.' | - |
| separator | 千位分隔符,为空或本身是数字串时不追加 | string | null | '' | - |
| keepTrailingZeros | 是否保留小数尾零 | boolean | false | - |
返回值:
| 类型 | 说明 |
|---|---|
string | 格式化后的数字字符串 |
formatName
参数:
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| name | 待打码的姓名 | string | - | - |
返回值:
| 类型 | 说明 |
|---|---|
string | 打码后的姓名;两字保留首字,三字及以上保留首末字,其余原样返回 |
timeFormat
参数:
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| dateTime | 时间戳(数字或字符串),null 时使用当前时间 | number | string | null | - | - |
| fmt | 格式化模板,支持 y / m / d / h / M / s | string | 'yyyy-mm-dd' | - |
返回值:
| 类型 | 说明 |
|---|---|
string | 按模板替换后的时间字符串 |
padZero
参数:
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| num | 待补零的数字,会先 Math.floor 取整 | number | - | - |
| width | 补零后的总位数 | number | 2 | - |
返回值:
| 类型 | 说明 |
|---|---|
string | 指定位数的补零字符串;原数字更长时原样返回 |
注意事项
formatNumber默认用parseFloat(toFixed())去掉小数尾零,只有keepTrailingZeros为true时才保留。formatNumber的separator为空串或本身是数字串时不做千分位分隔。timeFormat的m表示月份、M表示分钟,与常见习惯相反;10 位字符串时间戳按秒处理,结果随设备时区变化。formatName对两字姓名保留首字、三字及以上保留首末字,单字与空串原样返回。