国际化高可用和自动生成文档.pdfVIP

国际化⾼可⽤和⾃动⽣成⽂档 PHALAPI-⼊门篇4(国际化⾼可⽤和⾃动⽣成⽂档) 前⾔ 先在这⾥感谢phalapi框架创始⼈@dogstar,为我 提供了这样⼀个优秀的开源框架. 在本⼩节主要讲解如何使⽤phalapi框架⾃带的国际化和⽂档⾃动⽣成,以及这样做 以 的优点和好处和能解决哪⽅⾯的问题 附上: 官⽹地址:http://www .phalapi .net/ 开源中国Git地址:http://git ./dogstar/PhalApi/tree/release 1. 国际化 说道国际化⼤家应该不陌⽣,对于显⽰端(web ,andorid ,ios)来说就是对显⽰的内容 以任 意切换语⾔, 但对于服务端来说就是对于返回值 以任意切换语⾔,来达到给国外友⼈去使⽤这种业 务, 虽然说这种需求是少数,但是在框架内部有提供良好处理国际化这种业务的⼯具,让我 们先看看具体是什么样⼦的 ⼤家在init .php下⾯ 以看到这样⼀句话 //翻译语⾔包设定 SL(zh_cn); 这句话是指向了/Language/zh_cn/common.php⽂件,打开这个⽂件 以发现这样⼀组 对照关系 return array( Hi {name}, welcome to use PhalA i! = {name}您好，欢迎使⽤Pha user not exists = ⽤户不存在, ); 我们看看⾃带的Demo例⼦⾥⾯有使⽤到第⼀个,使⽤⽅法是这样的 content = T(Hi {name}, welcome to use PhalA i!, array(name ⼤家是不是感觉突然之间发现了什么,对的就是使⽤T⽅法我们看⼀下T⽅法的注释 /** * 快速翻译 * @ aram string $msg 待翻译的内容 * @ aram array $ arams 动态参数 */ 这⾥的$msg 也就是在common .php 中的ke ⽐如user not exists $params参数是⽤来替换ke ⾥⾯⽤{name}括弧括起来的参数的传递⼀个数组ke 就和 括弧⾥⾯的参数相同value就是你需要显⽰的类容 是不是感觉简单易⽤啊,那我们动⼿实验⼀下我们把zh_cn/common .php加⼊⼀条对照 Login success = 登录 功, 在en/common .php也加⼊⼀条数据 Login success = Login success1, 我们修改Default .index接⼜如下 ublic function index() { return T(Login success); } 我们看能得到什么结果 那我们把init .php 中的SL( zh_cn );改成SL( en );会有什么结果呢 就能得到我们在en/common.php 中写下的Login success1这样就 以轻易的切换返回语 ⾔从⽽实现国际化 但是它带来的好处不仅如此,还有易于修改和⾼ ⽤这两点好处 先说第⼀点易于修改:我在原来刚刚开始做项⽬的时候每个接⼜⾥⾯返回值全是写死 的,⽐如⽤户不存在这种等等的错误返回,当要修改的时候我们⾯临了⼀个问题全局替 换,这样是很不 取的所以后⾯就统⼀成了⼀个统⼀的⽂件来存放返回结果,当我们需 要把⽤户不存在修改成请确认⽤户的真实性这样的业务的时候,我们只需要修改⼀个统 ⼀的⽂件 好处之⼆就是⾼ ⽤,⾼ ⽤的表现又有两种⼀种是上⾯所说的项⽬内的复⽤,第⼆种 就是新项⽬的复⽤,当你开始⼀个新项⽬的时候其实已经有很多返回是通⽤的了,那么 你就 以直接使⽤或者是拷贝过来,很多重复的⼯作量就 以省去 2. ⽂档⾃动⽣成 ⼤家 以发现和index .php 以及init .php并⾏的还有⼀个checkApiParams.php⼀直没有⽤ 到,当我们试着去访问⼀下 看到了这样的页⾯,访问这个⽂件的时候和访问接⼜⼀样的默认访问了Default .index的 ⽂档页⾯也有说明 它的机制是通过接⼜⽂件上的注释⽣成的返回结果 /** * 默认接⼝服务 * @return string title 标题 * @return string content 内容 * @return string version 版本，格式：X