一、介绍

1．SDK适用语言

SDK适用于在Nodejs中调用service.youziku.com中的所有api

2.工作流程

①用户用后台程序调用SDK，提交动态内容到有字库的子集化(裁切)服务器
②服务器根据内容裁剪出对应的小字体文件，并转换为4种通用字体格式（woff、eot、ttf、svg）
③服务器将所有字体文件上传至阿里云CDN
④服务器用文件的CDN路径拼出@font-face语句
⑤服务器通过SDK将@font-face语句返回给用户的后台程序

3.@font-face语句

SDK的返回值主要内容是@font-face语句，@font-face语句是CSS3中的一个功能模块，是所有浏览器天然支持的CSS语句。它的作用是将一个远程字体文件加载到当前页面，并且定义成一个字体，前端页面能够像使用本地字体一样使用该字体。@font-face语句是实现在线字体效果的核心代码。

4. 显示字体效果

用户可以将@font-face语句与内容相对应保存至数据库，以便在内容被加载时，该语句能跟随内容一起加载到前端页面，从而使内容显示字体效果；
用户也可以不保存@font-face语句：有字库允许用户自定义字体存放路径，当需要显示字体效果时，可以根据自己所定义的路径拼组出@font-face语句，然后将语句输出到前端页面，即可使内容显示字体效果。

二、引用

npm安装

npm install youziku@4.0.0

三、Sample

1.初始化YouzikuClient

var youziku =require("youziku");
var youzikuClient = new youziku.youzikuClient("xxxxxx"); //apikey

2.单标签模式

2.1 GetFontface()

备注:直接返回所有格式的@fontface

var entity={
AccessKey:'xxxxxx',
Content:'有字库，让中文跃上云端！'
};

youzikuClient.getFontFace(entity, function (result) {
    console.log(result.FontFamily);
    console.log(result.FontFace);
    console.log(result.Code);
    console.log(result.Tag);
    console.log(result.ErrorMessage);
});

2.2 GetWoffBase64StringFontFace()

备注：直接返回流（woff流）的@fontface

var entity={
AccessKey:'xxxxxx',
Content:'有字库，让中文跃上云端！'
};

youzikuClient.getWoffBase64StringFontFace(entity, function (result) {
    console.log(result.FontFamily);
    console.log(result.FontFace);
    console.log(result.Code);
    console.log(result.Tag);
    console.log(result.ErrorMessage);
});

3.多标签生成模式

1.GetBatchFontFace()

备注：直接返回所有格式的@fontface;可传递多个标签和内容一次生成多个@fontface

var data = {
    Tags: []
};

data.Tags.push({ AccessKey: 'xxxxxx', Content: '有字库，让中文跃上云端！', Tag: '.test1' });
data.Tags.push({ AccessKey: 'xxxxxx', Content: '有字库，让中文跃上云端,**文字之美！', Tag: '#id2' });


youzikuClient.getBatchFontFace(data, function (result) {
    var length = result.FontfaceList.length;
    for (var i = 0; i < length; i++) {
        console.log(result.FontfaceList[i].Tag);
        console.log(result.FontfaceList[i].FontFace);
        console.log(result.FontfaceList[i].FontFamily);
    
    }
        console.log(result.Code);
        console.log(result.ErrorMessage);
});

2.GetBatchWoffFontFace ()

备注：直接返回仅woff格式的@fontface

var woffdata = {
    Tags: []
};

woffdata.Tags.push({ AccessKey: 'xxxxxx', Content: '有字库，让中文跃上云端！Woff格式', Tag: '.test1' });
woffdata.Tags.push({ AccessKey: 'xxxxxx', Content: '有字库，让中文跃上云端,**文字之美！Woff格式', Tag: '.test2' });


youzikuClient.getBatchWoffFontFace(woffdata, function (result) {
    var length = result.FontfaceList.length;
    for (var i = 0; i < length; i++) {
        console.log(result.FontfaceList[i].Tag);
        console.log(result.FontfaceList[i].FontFace);
        console.log(result.FontfaceList[i].FontFamily);

    }
    console.log(result.Code);
    console.log(result.ErrorMessage);
});

4.自定义路径生成模式

1.CreateBatchWoffWebFontAsync()

备注：自定义路径接口可以被程序异步调用，程序调用后可以直接向下执行，不需要等待返回值

当需要显示字体效果时，可以根据自己所定义的路径拼组出@font-face语句，然后将语句输出到前端页面，即可使内容显示字体效果。

var cdata = {
    Datas: []
};

cdata.Datas.push({ AccessKey: 'xxxxxx', Content: '有字库，让中文跃上云端！自定义路径接口', Url: 'youziku/test1' });
cdata.Datas.push({ AccessKey: 'xxxxxx', Content: '有字库，让中文跃上云端，**文字之美！Woff格式自定义路径接口', Url: 'youziku/test2' });

//1.捕获请求完成回调
youzikuClient.createBatchWoffWebFontAsync(cdata, function (result) {
    console.log(result.Code);
    console.log(result.ErrorMessage); 
})
//2.不捕获请求完成回调
youzikuClient.createBatchWoffWebFontAsync(cdata);

windreamlion/youziku-sdk-nodejs