MockUtils (commons-mock-data-spring-boot-starter 1.0.1 API)

java.lang.Object
- cn.fscode.commons.mock.data.utils.MockUtils

```
public class MockUtils
extends Object
```
数据模拟工具类

作者:

shenguangyang

字段概要

字段
限定符和类型字段和说明

static String base

static String num

字段
限定符和类型	字段和说明
`static String`	`base`
`static String`	`num`

构造器概要

构造器
构造器和说明

MockUtils()

构造器
构造器和说明
`MockUtils()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static boolean`	`bool()` 返回一个随机的布尔值.
`static boolean`	`bool(int min, int max, boolean current)` 返回一个随机的布尔值.
`static String`	`cfirst()` 随机生成一个常见的中文名
`static Character`	`character()` 返回一个随机字符。
`static Character`	`character(String pool)` 返回一个随机字符。
`static String`	`city()` 随机生成一个(中国)市
`static String`	`city(boolean prefix)` 随机生成一个(中国)市
`static String`	`clast()` 随机生成一个常见的中文姓
`static String`	`cname()` 随机生成一个常见的中文姓名
`static String`	`color()` 随机生成一个有吸引力的颜色，格式为 #RRGGBB
`static String`	`county()` 随机生成一个(中国)县
`static String`	`county(boolean prefix)` 随机生成一个(中国)县
`static String`	`cparagraph()` 随机生成一段中文文本
`static String`	`cparagraph(int len)` 随机生成一段中文文本
`static String`	`cparagraph(int min, int max)` 随机生成一段中文文本
`static String`	`ctitle()` 随机生成一句中文标题
`static String`	`ctitle(int len)` 随机生成一句中文标题
`static String`	`ctitle(int min, int max)` 随机生成一句中文标题
`static String`	`cword()` 随机生成一个汉字
`static String`	`cword(int length)` 随机生成 length 个汉字
`static String`	`cword(int min, int max)` 随机生成汉字
`static String`	`cword(String pool)` 随机生成一个汉字
`static String`	`cword(String pool, int min, int max)` 随机生成汉字
`static String`	`date()` 返回一个随机的日期字符串
`static String`	`date(String dateFormat)` 返回一个随机的日期字符串
`static String`	`datetime()` 返回一个随机的日期和时间字符串
`static String`	`datetime(String datetimeFormat)` 返回一个随机的日期和时间字符串。
`static String`	`domain()` 随机生成一个域名
`static String`	`email()` 随机生成一个邮件地址
`static String`	`email(String domain)` 随机生成一个邮件地址
`static String`	`first()` 随机生成一个常见的英文名
`static float`	`floatNumber()` 返回一个随机的浮点数
`static float`	`floatNumber(float min, float max, float dmin, float dmax)` 返回一个随机的浮点数。
`static String`	`getAddress()` 随机生成一个地址
`static String`	`getBirthday()` 随机生成出生日期
`static String`	`getChar()` 随机生成一个汉字
`static String`	`getChineseName()` 随机生成一个中文名字
`static String`	`getChineseStr(int lMin, int lMax)` 随机生成一段汉字
`static String`	`getEmail(int lMin, int lMax)` 随机获取一个Email地址
`static String`	`getIdCard()` 随机生成一个身份证号码
`static String`	`getLoginName(int length)` 随机生成一个登录名
`static String`	`getNumber(int length)` 随机生成一个数字的字符串
`static char`	`getSymbol()` 随机生成一个标点符号
`static String`	`getTel()` 随机生成一个电话号码
`static String`	`hex()` 随机生成一个有吸引力的颜色, 格式为 #RRGGBB
`static String`	`hsl()` 随机生成一个有吸引力的颜色，格式为 hsl(h, s, l)
`static String`	`id()` 随机生成一个 18 位身份证
`static String`	`image()` 生成一个随机的图片地址
`static String`	`image(String size)` 生成一个随机的图片地址
`static String`	`image(String size, String background)` 生成一个随机的图片地址
`static String`	`image(String size, String background, String text)` 生成一个随机的图片地址
`static String`	`image(String size, String background, String foreground, String text)` 生成一个随机的图片地址
`static String`	`image(String size, String background, String foreground, String imgFormat, String text)` 生成一个随机的图片地址
`static String`	`ip()` 随机生成一个 IP 地址
`static String`	`last()` 随机生成一个常见的英文姓
`static Map`	`mock(String template)` 根据数据模板生成模拟数据
`static Object`	`mockRandom(String script)` 调用mockJs生成模拟数据
`static String`	`name()` 随机生成一个常见的英文姓名
`static String`	`name(boolean middle)` 随机生成一个常见的英文姓名
`static long`	`natural()` 返回一个随机的自然数（大于等于 0 的整数）。
`static long`	`natural(long min)` 返回一个随机的自然数（大于等于 0 的整数）
`static long`	`natural(long min, long max)` 返回一个随机的自然数（大于等于 0 的整数）
`static String`	`paragraph()` 随机生成一段英文文本
`static String`	`paragraph(int len)` 随机生成一段英文文本
`static String`	`paragraph(int min, int max)` 随机生成一段英文文本
`static String`	`protocol()` 随机生成一个 URL 协议
`static String`	`province()` 随机生成一个 (中国) 省 (或直辖市、自治区、特别行政区)
`static Integer[]`	`range(int start, int stop)` 返回一个整型数组。
`static Integer[]`	`range(int start, int stop, int step)` 返回一个整型数组。
`static String`	`region()` 随机生成一个(中国)大区
`static String`	`rgb()` 随机生成一个有吸引力的颜色，格式为 rgb(r, g, b)
`static String`	`rgba()` 随机生成一个有吸引力的颜色，格式为 rgba(r, g, b, a)
`static String`	`string(String pool, int length)` 返回一个随机字符串.
`static String`	`string(String pool, int min, int max)` 返回一个随机字符串
`static String`	`time()` 返回一个随机的时间字符串
`static String`	`time(String timeFormat)` 返回一个随机的时间字符串
`static String`	`title()` 随机生成一句标题, 其中每个单词的首字母大写
`static String`	`title(int len)` 随机生成一句标题, 其中每个单词的首字母大写
`static String`	`title(int min, int max)` 随机生成一句标题, 其中每个单词的首字母大写
`static String`	`tld()` 随机生成一个顶级域名(Top Level Domain)
`static String`	`url()` 随机生成一个 URL
`static String`	`url(String protocol, String host)` 随机生成一个 URL
`static String`	`verificationCode(String str17)` 生成第18位身份证号
`static String`	`word()` 随机生成一个单词
`static String`	`word(int len)` 随机生成一个单词
`static String`	`word(int min, int max)` 随机生成一个单词
`static String`	`zip()` 随机生成一个邮政编码(六位数字)

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - num
```
public static String num
```
  - base
```
public static String base
```
- 构造器详细资料
  - MockUtils
```
public MockUtils()
```
- 方法详细资料
  - getNumber
```
public static String getNumber(int length)
```
    随机生成一个数字的字符串
    
    参数:
    
    length - 长度
  - getEmail
```
public static String getEmail(int lMin,
                              int lMax)
```
    随机获取一个Email地址
    
    参数:
    
    lMin - 最小长度
    
    lMax - 最大长度
  - getTel
```
public static String getTel()
```
    随机生成一个电话号码
  - getChineseName
```
public static String getChineseName()
```
    随机生成一个中文名字
  - getAddress
```
public static String getAddress()
```
    随机生成一个地址
  - getLoginName
```
public static String getLoginName(int length)
```
    随机生成一个登录名
  - getSymbol
```
public static char getSymbol()
```
    随机生成一个标点符号
  - getChar
```
public static String getChar()
```
    随机生成一个汉字
  - getChineseStr
```
public static String getChineseStr(int lMin,
                                   int lMax)
```
    随机生成一段汉字
    
    参数:
    
    lMin - 最小长度
    
    lMax - 最大长度
  - getBirthday
```
public static String getBirthday()
```
    随机生成出生日期
  - verificationCode
```
public static String verificationCode(String str17)
```
    生成第18位身份证号
  - getIdCard
```
public static String getIdCard()
```
    随机生成一个身份证号码
  - mockRandom
```
public static Object mockRandom(String script)
```
    调用mockJs生成模拟数据
    
    参数:
    
    script - js脚本
  - bool
```
public static boolean bool()
```
    返回一个随机的布尔值.
  - bool
```
public static boolean bool(int min,
                           int max,
                           boolean current)
```
    返回一个随机的布尔值.
    
    参数:
    
    min - 指示参数 current 出现的概率。概率计算公式为 min / (min + max)。该参数的默认值为 1，即有 50% 的概率返回参数 current。
    
    max - 指示参数 current 的相反值 !current 出现的概率。概率计算公式为 max / (min + max)。该参数的默认值为 1，即有 50% 的概率返回参数 !current。
    
    current - 可选值为布尔值 true 或 false。如果未传入任何参数，则返回 true 和 false 的概率各为 50%。该参数没有默认值。在该方法的内部，依据原生方法 Math.random() 返回的（浮点）数来计算和返回布尔值，例如在最简单的情况下，返回值是表达式 Math.random() >= 0.5 的执行结果。
    
    返回:
    
    the boolean
  - natural
```
public static long natural()
```
    返回一个随机的自然数（大于等于 0 的整数）。
  - natural
```
public static long natural(long min)
```
    返回一个随机的自然数（大于等于 0 的整数）
    
    参数:
    
    min - 指示随机自然数的最小值。默认值为 0。
  - natural
```
public static long natural(long min,
                           long max)
```
    返回一个随机的自然数（大于等于 0 的整数）
    
    参数:
    
    min - 指示随机自然数的最小值。默认值为 0。
    
    max - 指示随机自然数的最大值。默认值为 9007199254740992
  - floatNumber
```
public static float floatNumber()
```
    返回一个随机的浮点数
    
    返回:
    
    返回一个随机的浮点数
  - floatNumber
```
public static float floatNumber(float min,
                                float max,
                                float dmin,
                                float dmax)
```
    返回一个随机的浮点数。
    
    参数:
    
    min - 整数部分的最小值。默认值为 -9007199254740992。
    
    max - 整数部分的最大值。默认值为 9007199254740992。
    
    dmin - 小数部分位数的最小值。默认值为 0。
    
    dmax - 小数部分位数的最大值。默认值为 17。
  - character
```
public static Character character()
```
    返回一个随机字符。范围：abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%^&*()[]
  - character
```
public static Character character(String pool)
```
    返回一个随机字符。
    
    参数:
    
    pool - 表示字符池，将从中选择一个字符返回
    lower: "abcdefghijklmnopqrstuvwxyz",
    upper: "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    number: "0123456789",
    symbol: "!@#$%^&*()[]"
    也可自定义
  - string
```
public static String string(String pool,
                            int length)
```
    返回一个随机字符串.
    
    参数:
    
    pool - 表示字符池，将从中选择一个字符返回
    
    length - 返回的长度
  - string
```
public static String string(String pool,
                            int min,
                            int max)
```
    返回一个随机字符串
    
    参数:
    
    pool - 表示字符池，将从中选择一个字符返回
    
    min - 随机字符串的最小长度, 默认值为 3
    
    max - 随机字符串的最大长度, 默认值为 7
  - range
```
public static Integer[] range(int start,
                              int stop)
```
    返回一个整型数组。
    
    参数:
    
    start - 数组中整数的起始值
    
    stop - 数组中整数的结束值(不包含在返回值中)
  - range
```
public static Integer[] range(int start,
                              int stop,
                              int step)
```
    返回一个整型数组。
    
    参数:
    
    start - 数组中整数的起始值
    
    stop - 数组中整数的结束值(不包含在返回值中)
    
    step - 数组中整数之间的步长, 默认值为 1
  - date
```
public static String date()
```
    返回一个随机的日期字符串
  - date
```
public static String date(String dateFormat)
```
    返回一个随机的日期字符串
    
    参数:
    
    dateFormat - 指示生成的日期字符串的格式, 默认值为 yyyy-MM-dd
  - time
```
public static String time()
```
    返回一个随机的时间字符串
  - time
```
public static String time(String timeFormat)
```
    返回一个随机的时间字符串
    
    参数:
    
    timeFormat - 指示生成的时间字符串的格式, 默认值为 HH:mm:ss
    
    返回:
    
    时间字符串
  - datetime
```
public static String datetime()
```
    返回一个随机的日期和时间字符串
    
    返回:
    
    随机的日期和时间字符串
  - datetime
```
public static String datetime(String datetimeFormat)
```
    返回一个随机的日期和时间字符串。
    
    参数:
    
    datetimeFormat - 指示生成的日期和时间字符串的格式, 默认值为 yyyy-MM-dd HH:mm:ss
    
    返回:
    
    随机的日期和时间字符串
  - image
```
public static String image()
```
    生成一个随机的图片地址
    
    返回:
    
    图片地址
  - image
```
public static String image(String size)
```
    生成一个随机的图片地址
    
    参数:
    
    size - 指示图片的宽高, 格式为 '宽x高', 例如: “300x250”, ”360x123“
    
    返回:
    
    图片地址
  - image
```
public static String image(String size,
                           String background)
```
    生成一个随机的图片地址
    
    参数:
    
    size - 指示图片的宽高, 格式为 '宽x高', 例如: “300x250”, ”360x123“
    
    background - 指示图片的背景色, 默认值为 '#000000'
  - image
```
public static String image(String size,
                           String background,
                           String text)
```
    生成一个随机的图片地址
    
    参数:
    
    size - 指示图片的宽高, 格式为 '宽x高', 例如: “300x250”, ”360x123“
    
    background - 指示图片的背景色, 默认值为 '#000000'
    
    text - 指示图片上的文字, 默认值为参数 size
    
    返回:
    
    随机的图片地址
  - image
```
public static String image(String size,
                           String background,
                           String foreground,
                           String text)
```
    生成一个随机的图片地址
    
    参数:
    
    size - 指示图片的宽高, 格式为 '宽x高', 例如: “300x250”, ”360x123“
    
    background - 指示图片的背景色, 默认值为 '#000000'
    
    foreground - 指示图片的前景色(文字), 默认值为 '#FFFFFF'
    
    text - 指示图片上的文字, 默认值为参数 size
    
    返回:
    
    图片地址
  - image
```
public static String image(String size,
                           String background,
                           String foreground,
                           String imgFormat,
                           String text)
```
    生成一个随机的图片地址
    
    参数:
    
    size - 指示图片的宽高, 格式为宽x高, 例如: 300x250 | 360x123
    
    background - 指示图片的背景色, 默认值为 #000000
    
    foreground - 指示图片的前景色(文字), 默认值为 #FFFFFF
    
    imgFormat - 指示图片的格式, 默认值为 png, 可选值包括: png | gif | jpg
    
    text - 指示图片上的文字, 默认值为参数 size
    
    返回:
    
    图片地址
  - color
```
public static String color()
```
    随机生成一个有吸引力的颜色，格式为 #RRGGBB
    
    返回:
    
    随机生成一个有吸引力的颜色
  - hex
```
public static String hex()
```
    随机生成一个有吸引力的颜色, 格式为 #RRGGBB
    
    返回:
    
    随机生成一个有吸引力的颜色
  - rgb
```
public static String rgb()
```
    随机生成一个有吸引力的颜色，格式为 rgb(r, g, b)
    
    返回:
    
    随机生成一个有吸引力的颜色
  - rgba
```
public static String rgba()
```
    随机生成一个有吸引力的颜色，格式为 rgba(r, g, b, a)
    
    返回:
    
    随机生成一个有吸引力的颜色
  - hsl
```
public static String hsl()
```
    随机生成一个有吸引力的颜色，格式为 hsl(h, s, l)
    
    返回:
    
    随机生成一个有吸引力的颜色
  - paragraph
```
public static String paragraph()
```
    随机生成一段英文文本
    
    返回:
    
    英文文本
  - paragraph
```
public static String paragraph(int len)
```
    随机生成一段英文文本
    
    参数:
    
    len - 指示文本中句子的个数, 默认值为 3 到 7 之间的随机数
    
    返回:
    
    英文文本
  - paragraph
```
public static String paragraph(int min,
                               int max)
```
    随机生成一段英文文本
    
    参数:
    
    min - 指示文本中句子的最小个数, 默认值为 3
    
    max - 指示文本中句子的最大个数, 默认值为 7
    
    返回:
    
    英文文本
  - cparagraph
```
public static String cparagraph()
```
    随机生成一段中文文本
    
    返回:
    
    中文文本
  - cparagraph
```
public static String cparagraph(int len)
```
    随机生成一段中文文本
    
    参数:
    
    len - 指示文本中句子的个数。默认值为 3 到 7 之间的随机数
    
    返回:
    
    中文文本
  - cparagraph
```
public static String cparagraph(int min,
                                int max)
```
    随机生成一段中文文本
    
    参数:
    
    min - 指示文本中句子的最小个数, 默认值为 3
    
    max - 指示文本中句子的最大个数, 默认值为 7
    
    返回:
    
    中文文本
  - word
```
public static String word()
```
    随机生成一个单词
    
    返回:
    
    单词
  - word
```
public static String word(int len)
```
    随机生成一个单词
    
    参数:
    
    len - 指示单词中字符的个数。默认值为 3 到 10 之间的随机数。
    
    返回:
    
    单词
  - word
```
public static String word(int min,
                          int max)
```
    随机生成一个单词
    
    参数:
    
    min - 指示单词中字符的最小个数, 默认值为 3
    
    max - 指示单词中字符的最大个数, 默认值为 10
    
    返回:
    
    单词
  - cword
```
public static String cword()
```
    随机生成一个汉字
    
    返回:
    
    汉字
  - cword
```
public static String cword(String pool)
```
    随机生成一个汉字
    
    参数:
    
    pool - 汉字字符串, 表示汉字字符池, 将从中选择一个汉字字符返回
    
    返回:
    
    汉字
  - cword
```
public static String cword(int length)
```
    随机生成 length 个汉字
    
    参数:
    
    length - 随机字符串的长度
    
    返回:
    
    汉字
  - cword
```
public static String cword(int min,
                           int max)
```
    随机生成汉字
    
    参数:
    
    min - 随机汉字字符串的最小长度, 默认值为 1
    
    max - 随机汉字字符串的最大长度, 默认值为 1
    
    返回:
    
    汉字
  - cword
```
public static String cword(String pool,
                           int min,
                           int max)
```
    随机生成汉字
    
    参数:
    
    pool - 汉字字符串。表示汉字字符池, 将从中选择一个汉字字符返回
    
    min - 随机汉字字符串的最小长度, 默认值为 1
    
    max - 随机汉字字符串的最大长度, 默认值为 1
    
    返回:
    
    汉字
  - title
```
public static String title()
```
    随机生成一句标题, 其中每个单词的首字母大写
    
    返回:
    
    标题
  - title
```
public static String title(int len)
```
    随机生成一句标题, 其中每个单词的首字母大写
    
    参数:
    
    len - 指示单词中字符的个数, 默认值为 3 到 7 之间的随机数
    
    返回:
    
    一句标题
  - title
```
public static String title(int min,
                           int max)
```
    随机生成一句标题, 其中每个单词的首字母大写
    
    参数:
    
    min - 指示单词中字符的最小个数, 默认值为 3
    
    max - 指示单词中字符的最大个数, 默认值为 7
    
    返回:
    
    一句标题
  - ctitle
```
public static String ctitle()
```
    随机生成一句中文标题
    
    返回:
    
    中文标题
  - ctitle
```
public static String ctitle(int len)
```
    随机生成一句中文标题
    
    参数:
    
    len - 指示单词中字符的个数, 默认值为 3 到 7 之间的随机数
    
    返回:
    
    中文标题
  - ctitle
```
public static String ctitle(int min,
                            int max)
```
    随机生成一句中文标题
    
    参数:
    
    min - 指示单词中字符的最小个数, 默认值为 3
    
    max - 指示单词中字符的最大个数, 默认值为 7
    
    返回:
    
    中文标题
  - first
```
public static String first()
```
    随机生成一个常见的英文名
    
    返回:
    
    常见的英文名
  - last
```
public static String last()
```
    随机生成一个常见的英文姓
    
    返回:
    
    常见的英文姓
  - name
```
public static String name()
```
    随机生成一个常见的英文姓名
    
    返回:
    
    英文姓名
  - name
```
public static String name(boolean middle)
```
    随机生成一个常见的英文姓名
    
    参数:
    
    middle - 指示是否生成中间名
    
    返回:
    
    英文姓名
  - cfirst
```
public static String cfirst()
```
    随机生成一个常见的中文名
    
    返回:
    
    常见的中文名
  - clast
```
public static String clast()
```
    随机生成一个常见的中文姓
    
    返回:
    
    常见的中文姓
  - cname
```
public static String cname()
```
    随机生成一个常见的中文姓名
    
    返回:
    
    常见的中文姓名
  - url
```
public static String url()
```
    随机生成一个 URL
    
    返回:
    
    URL
  - url
```
public static String url(String protocol,
                         String host)
```
    随机生成一个 URL
    
    参数:
    
    protocol - 指定 URL 协议, 例如 http
    
    host - 指定 URL 域名和端口号, 例如 nuysoft.com
    
    返回:
    
    URL
  - protocol
```
public static String protocol()
```
    随机生成一个 URL 协议
    
    返回:
    
    生成一个 URL 协议, 返回以下值之一:
    http | ftp | gopher | mailto | mid | cid | news | nntp | prospero | telnet | rlogin | tn3270 | wais
  - domain
```
public static String domain()
```
    随机生成一个域名
    
    返回:
    
    域名
  - tld
```
public static String tld()
```
    随机生成一个顶级域名(Top Level Domain)
    
    返回:
    
    顶级域名
  - email
```
public static String email()
```
    随机生成一个邮件地址
    
    返回:
    
    邮件地址
  - email
```
public static String email(String domain)
```
    随机生成一个邮件地址
    
    返回:
    
    邮件地址
  - ip
```
public static String ip()
```
    随机生成一个 IP 地址
    
    返回:
    
    IP 地址
  - region
```
public static String region()
```
    随机生成一个(中国)大区
    
    返回:
    
    (中国)大区
  - province
```
public static String province()
```
    随机生成一个 (中国) 省 (或直辖市、自治区、特别行政区)
    
    返回:
    
    (中国) 省 (或直辖市、自治区、特别行政区)
  - city
```
public static String city()
```
    随机生成一个(中国)市
    
    返回:
    
    (中国)市
  - city
```
public static String city(boolean prefix)
```
    随机生成一个(中国)市
    
    参数:
    
    prefix - 指示是否生成所属的省。
    
    返回:
    
    (中国)市
  - county
```
public static String county()
```
    随机生成一个(中国)县
    
    返回:
    
    随机生成一个(中国)县
  - county
```
public static String county(boolean prefix)
```
    随机生成一个(中国)县
    
    参数:
    
    prefix - 指示是否生成所属的省。
    
    返回:
    
    (中国)县
  - zip
```
public static String zip()
```
    随机生成一个邮政编码(六位数字)
    
    返回:
    
    邮政编码
  - id
```
public static String id()
```
    随机生成一个 18 位身份证
    
    返回:
    
    18 位身份证
  - mock
```
public static Map mock(String template)
```
    根据数据模板生成模拟数据
    
    参数:
    
    template - 表示数据模板, 可以是对象或字符串, 例如 { 'data|1-10':[{}] }、@EMAIL
    
    返回:
    
    生成模拟数据

类 MockUtils

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

num

base

构造器详细资料

MockUtils

方法详细资料

getNumber

getEmail

getTel

getChineseName

getAddress

getLoginName

getSymbol

getChar

getChineseStr

getBirthday

verificationCode

getIdCard

mockRandom

bool

bool

natural

natural

natural

floatNumber

floatNumber

character

character

string

string

range

range

date

date

time

time

datetime

datetime

image

image

image

image

image

image

color

hex

rgb

rgba

hsl

paragraph

paragraph

paragraph

cparagraph

cparagraph

cparagraph

word

word

word

cword

cword

cword

cword

cword

title

title

title

ctitle

ctitle

ctitle

first

last

name

name

cfirst

clast