taro+ts+dva+微信小程序云开发实现《诗词小程序》

项目初始化

如果未安装taro的话先使用下面命令安装

$ yarn global add @tarojs/cli

安装完成后就可以使用taro命令创建项目了

$ taro init poetry

输入创建命令时会让你选择语言,类型什么的,因为我们是用typescript,所以选择是就行了。

图片

配置云开发

taro是支持小程序云开发模式的,具体看文档https://taro-docs.jd.com/taro/docs/wxcloudbase,使用云开发模板的目录结构如下,

├── client                                  小程序端目录
│   ├── config                              配置目录
│   │   ├── dev.js                          开发时配置
│   │   ├── index.js                        默认配置
│   │   └── prod.js                         打包时配置
│   ├── dist                                编译结果目录
│   ├── package.json
│   ├── src                                 源码目录
│   │   ├── app.scss                        项目总通用样式
│   │   ├── app.js                          项目入口文件
│   │   ├── components                      组件文件目录
│   │   └── pages                           页面文件目录
├── cloud                                   服务端目录
│   └── functions                           云函数目录
│       └── login                           login 云函数
│           ├── index.js                    login 函数逻辑
│           └── package.json
└── project.config.json                     小程序项目配置

文档的介绍是这样的:

  1. 开发时,进入 client 目录,在此目录下运行相关编译预览或打包命令
  2. 使用微信开发者工具调试项目,请将项目整个文件夹作为运行目录。 注意: 不是 client 中生成的 dist 文件夹

必须将整个项目作为运行目录,我觉得这样挺麻烦的,其实云开发主要是比普通开发多了一个云开发的文件夹,只要我们改写一下配置,把输出目录修改一下就可以了。

首先我们先修改下文件目录结构

├── poetry  
│   ├── config                              配置目录
│   │   ├── dev.js                          开发时配置
│   │   ├── index.js                        默认配置
│   │   └── prod.js                         打包时配置
│   ├── package.json
│   ├── src                                 源码目录
│   │   ├── app.scss                        项目总通用样式
│   │   ├── app.tsx                          项目入口文件
│   │   ├── components                      组件文件目录
│   │   └── pages                           页面文件目录
│   ├── wx_output                           编译输出目录
│       └── cloudfunctions                  云函数目录
│           └── login                       login 云函数
│               ├── index.js                    
│               └── package.json
│   └── miniprogram                          小程序编译目录
└── project.config.json                     小程序项目配置

然后我们修改一下config/index.js下的文件内容

const outputRoot = process.env.TARO_ENV === 'weapp' ? 'wx_output/miniprogram' : 'dist';

const config = {
  ...
  outputRoot: outputRoot,
  ...
},

module.exports = function (merge) {
if (process.env.NODE_ENV === 'development') {
  return merge({}, config, require('./dev'))
}
return merge({}, config, require('./prod'))
}

通过改写配置我把编译输出目录改成了 wx_output/miniprogram 文件夹,只要把wx_output作为小程序项目的根目录就可以了,不过有一点要注意下,因为编译时project.config.json是编译在miniprogram文件夹下的,小程序要求在必须在根目录下才行,所以我们还要将project.config.json移动到wx_output/目录下才能正常运行。

其它的一些需要配置的只要参考微信云开发文档进行配置就行了,这个问题不大。

定义ts接口

scr 目录下新建 typings 文件夹,然后新建 store.d.ts 文件,文件里可以定义我们所需要的ts接口,如下

...
interface ToastParams {
  title: string,
  duration?: number,
  icon?: iconType
}

interface 诗词详情数据 {
  poetryInfo: poetryItem,
  tag: string
}

interface 作者相关 {
  authorInfo: 作者数据,
  hasAuthor: boolean
}

interface 作者数据 {
  _id: string,
  description: string,
  name: string,
  short_description: string,
  imgUrl?: string
}
...

试了一下中文也是可以的,定义完成后就可以直接在项目中使用该类型了

type PageDispatchProps = {
  dispatch: (object)=>void
  poetryDetail: 诗词详情数据
  author: 作者相关
}

数据来源

小程序所用数据来源于https://github.com/chinese-poetry/chinese-poetry,将该数据通过json导入云开发数据库就可以了,我根据诗词的类型创建了不同的数据集

图片

创建云函数

参考文档新建所需的云函数,比如新建一个获取所有诗词类别的方法

async allCategories(params) {// 获取所有诗词类别
  try {
    const data = await db.collection('catalog').get();
    return await this.success(data);
  }catch(err) {
    return await this.failMsg(err);
  }
}

使用dva

先安装dva所需依赖 dva-core dva-loading redux等,安装完后在src文件夹下新建models文件夹,新建index.ts文件,内容如下,

import poetryDetail from '../pages/model/poetryDetail'
import author from '../pages/model/author'

let list = [
  poetryDetail,
  author
];

export default list;

上面的../pages/model/poetryDetail还有../pages/model/author就是我需要共用的数据文件,具体写法可以参考dva教程,文件的模板如下:

export default {
  namespace: 'xxx',

  state: {// 存放数据
  },

  effects: {
    // 定义方法
    *someFunction({payload, callback}, {call, put}) {

    }
  },

  reducers: {
    save(state, {payload}) {
      return {
        ...state,
        ...payload
      }
    }
  }
}

修改app.tsx文件

import Taro, { Component, Config } from '@tarojs/taro'
import {Provider} from '@tarojs/redux'
import models from './models/index'
import dva from './utils/dva'
import Index from './pages/index'

import './app.scss'

const dvaApp = dva.createApp( {
  initialState: {},
  models
});  
const store = dvaApp.getStore();

// 如果需要在 h5 环境中开启 React Devtools
// 取消以下注释:
// if (process.env.NODE_ENV !== 'production' && process.env.TARO_ENV === 'h5')  {
//   require('nerv-devtools')
// }

class App extends Component {

  componentDidMount () {
    if (process.env.TARO_ENV === 'weapp') {
      Taro.cloud.init({
        env: 'xxx',
        traceUser: true
      })
    }
  }

  config: Config = {
    ...
  }

  // 在 App 类中的 render() 函数没有实际作用
  // 请勿修改此函数
  render () {
    return (
      <Provider store={store} >
        <Index />
      </Provider>
    )
  }
}

Taro.render(<App />, document.getElementById('app'))

在需要使用dva的页面中加入构造器就行了

@connect(
  ({poetryDetail,author}) => ({poetryDetail,author})
)

class xxx extends Component<IProps, PageState> {
  ...
}

export default xxx

配置完成后我们就可以在页面中调用了,要使用某个方法时,可以这样

  const { dispatch } = this.props;
  dispatch({
    type: 'author/someFunction',
    payload: {
      clounFnName: 'poetry', 
      controller: 'poetry',
      action: 'getHotAuthor',
    },
    callback: res => {
      this.setState({
        hotAuthor: res.data
      })
    }
  })

总结

第一次用ts来开发小程序,算是当作练手,熟悉一下ts在项目中的运用以及一些需要注意的点,这个小程序比较简单,也没有什么难点,用来练习正好,一些细节方面的东西我也没用讲到,可以直接看源码了解,也可以扫下面这个小程序进行体验,有什么建议也欢迎提出。

小程序码
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345

推荐阅读更多精彩内容