记录一个基于vue2的小组件升级为基于vue3的组件

469 阅读1分钟

最近用vue3+vue-router4+vuex4搭建了一个项目框架,用到了一个基于vue2的小组件,遂将它改成了基于vue3的,在修改的过程中出现了一个小问题,在查资料修改的过程中对vue3的一些概念的理解又深刻了一些,遂记录下来。

原组件是一个图片验证码,源代码非常简单,代码如下:地址

<template>
  <div class="img-verify">
    <canvas ref="verify" :width="width" :height="height" @click="handleDraw"></canvas>
  </div>
</template>

<script type="text/ecmascript-6">
export default {
  data() {
    return {
      pool: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890', // 字符串
      width: 120,
      height: 40,
      imgCode: ''
    }
  },
  mounted() {
    // 绘制图片验证码
    this.handleDraw();
  },
  methods: {
    // 点击图片重新绘制
    handleDraw() {
      this.$emit('getImgCode', this.draw())
    },
    // 1.随机数
    randomNum(min, max) {
      return parseInt(Math.random() * (max - min) + min)
    },
    // 2.随机颜色
    randomColor(min, max) {
      const r = this.randomNum(min, max)
      const g = this.randomNum(min, max)
      const b = this.randomNum(min, max)
      return `rgb(${r},${g},${b})`
    },
    // 绘制图片
    draw() {
      // 3.填充背景颜色,背景颜色要浅一点
      const ctx = this.$refs.verify.getContext('2d')
      // 填充颜色
      ctx.fillStyle = this.randomColor(180, 230)
      // 填充的位置
      ctx.fillRect(0, 0, this.width, this.height)
      // 定义paramText
      let imgCode = ''
      // 4.随机产生字符串,并且随机旋转
      for (let i = 0; i < 4; i++) {
        // 随机的四个字
        const text = this.pool[this.randomNum(0, this.pool.length)]
        imgCode += text
        // 随机的字体大小
        const fontSize = this.randomNum(18, 40)
        // 字体随机的旋转角度
        const deg = this.randomNum(-30, 30)
        /*
         * 绘制文字并让四个文字在不同的位置显示的思路 :
         * 1、定义字体
         * 2、定义对齐方式
         * 3、填充不同的颜色
         * 4、保存当前的状态(以防止以上的状态受影响)
         * 5、平移translate()
         * 6、旋转 rotate()
         * 7、填充文字
         * 8、restore出栈
         * */
        ctx.font = fontSize + 'px Simhei'
        ctx.textBaseline = 'top'
        ctx.fillStyle = this.randomColor(80, 150)
        /*
         * save() 方法把当前状态的一份拷贝压入到一个保存图像状态的栈中。
         * 这就允许您临时地改变图像状态,
         * 然后,通过调用 restore() 来恢复以前的值。
         * save是入栈,restore是出栈。
         * 用来保存Canvas的状态。save之后,可以调用Canvas的平移、放缩、旋转、错切、裁剪等操作。 restore:用来恢复Canvas之前保存的状态。防止save后对Canvas执行的操作对后续的绘制有影响。
         *
         * */
        ctx.save()
        ctx.translate(30 * i + 15, 15)
        ctx.rotate((deg * Math.PI) / 180)
        // fillText() 方法在画布上绘制填色的文本。文本的默认颜色是黑色。
        // 请使用 font 属性来定义字体和字号,并使用 fillStyle 属性以另一种颜色/渐变来渲染文本。
        // context.fillText(text,x,y,maxWidth);
        ctx.fillText(text, -15 + 5, -15)
        ctx.restore()
      }
      // 5.随机产生5条干扰线,干扰线的颜色要浅一点
      for (let i = 0; i < 5; i++) {
        ctx.beginPath()
        ctx.moveTo(this.randomNum(0, this.width), this.randomNum(0, this.height))
        ctx.lineTo(this.randomNum(0, this.width), this.randomNum(0, this.height))
        ctx.strokeStyle = this.randomColor(180, 230)
        ctx.closePath()
        ctx.stroke()
      }
      // 6.随机产生40个干扰的小点
      for (let i = 0; i < 40; i++) {
        ctx.beginPath()
        ctx.arc(this.randomNum(0, this.width), this.randomNum(0, this.height), 1, 0, 2 * Math.PI)
        ctx.closePath()
        ctx.fillStyle = this.randomColor(150, 200)
        ctx.fill()
      }
      return imgCode
    }
  }
}
</script>
<style type="text/css">
.img-verify canvas {
  cursor: pointer;
}
</style>

修改的思路:

  1. 将export default对象中的data、methods等用setup代替
  2. 将原data中的数据用reactive定义,用return导出
  3. methods中的方法直接在setup中定义
  4. 去掉this,emit来源为setup的参数
  5. this.$refs用ref定义并return,ref的值用ref().value代替(注意:查资料说是这么改的) 修改后的代码如下:
<template>
  <div class="img-verify">
    <canvas ref="verify" :width="data.width" :height="data.height" @click="handleDraw"></canvas>
  </div>
</template>

<script>
import { reactive ,ref,onMounted} from 'vue';
export default {
  setup(props,{emit}){
    const data=reactive({
      pool: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890', // 字符串
      width: 120,
      height: 40,
      imgCode: ''
    })
    const verify=ref(null);
    handleDraw();
    function handleDraw(){
      emit('getImgCode', draw())
    }
    // 1.随机数
    function randomNum(min, max) {
      return parseInt(Math.random() * (max - min) + min)
    }
    // 2.随机颜色
    function randomColor(min, max) {
      const r = randomNum(min, max)
      const g = randomNum(min, max)
      const b = randomNum(min, max)
      return `rgb(${r},${g},${b})`
    }
   
    function draw() {
      // 3.填充背景颜色,背景颜色要浅一点
      const ctx = verify.value.getContext('2d')
      // 填充颜色
      ctx.fillStyle = randomColor(180, 230)
      // 填充的位置
      ctx.fillRect(0, 0, data.width, data.height)
      // 定义paramText
      let imgCode = ''
      // 4.随机产生字符串,并且随机旋转
      for (let i = 0; i < 4; i++) {
        // 随机的四个字
        const text = data.pool[randomNum(0, data.pool.length)]
        imgCode += text
        // 随机的字体大小
        const fontSize = randomNum(18, 40)
        // 字体随机的旋转角度
        const deg = randomNum(-30, 30)
        /*
         * 绘制文字并让四个文字在不同的位置显示的思路 :
         * 1、定义字体
         * 2、定义对齐方式
         * 3、填充不同的颜色
         * 4、保存当前的状态(以防止以上的状态受影响)
         * 5、平移translate()
         * 6、旋转 rotate()
         * 7、填充文字
         * 8、restore出栈
         * */
        ctx.font = fontSize + 'px Simhei'
        ctx.textBaseline = 'top'
        ctx.fillStyle = randomColor(80, 150)
        /*
         * save() 方法把当前状态的一份拷贝压入到一个保存图像状态的栈中。
         * 这就允许您临时地改变图像状态,
         * 然后,通过调用 restore() 来恢复以前的值。
         * save是入栈,restore是出栈。
         * 用来保存Canvas的状态。save之后,可以调用Canvas的平移、放缩、旋转、错切、裁剪等操作。 restore:用来恢复Canvas之前保存的状态。防止save后对Canvas执行的操作对后续的绘制有影响。
         *
         * */
        ctx.save()
        ctx.translate(30 * i + 15, 15)
        ctx.rotate((deg * Math.PI) / 180)
        // fillText() 方法在画布上绘制填色的文本。文本的默认颜色是黑色。
        // 请使用 font 属性来定义字体和字号,并使用 fillStyle 属性以另一种颜色/渐变来渲染文本。
        // context.fillText(text,x,y,maxdata.width);
        ctx.fillText(text, -15 + 5, -15)
        ctx.restore()
      }
      // 5.随机产生5条干扰线,干扰线的颜色要浅一点
      for (let i = 0; i < 5; i++) {
        ctx.beginPath()
        ctx.moveTo(randomNum(0, data.width), randomNum(0, data.height))
        ctx.lineTo(randomNum(0, data.width), randomNum(0, data.height))
        ctx.strokeStyle = randomColor(180, 230)
        ctx.closePath()
        ctx.stroke()
      }
      // 6.随机产生40个干扰的小点
      for (let i = 0; i < 40; i++) {
        ctx.beginPath()
        ctx.arc(randomNum(0, data.width), randomNum(0, data.height), 1, 0, 2 * Math.PI)
        ctx.closePath()
        ctx.fillStyle = randomColor(150, 200)
        ctx.fill()
      }
      return imgCode
    }
    return {data,verify}
  }
  

  
}
</script>
<style type="text/css">
.img-verify canvas {
  cursor: pointer;
}
</style>

但是,这样代码报错,说value前面的值为undefind,查了好多资料都说这么改没问题,但就是报错,无奈继续查,终于在查资料的过程中看到了一句话给了我启发

setup执行时尚未创建组件实例

既然setup执行时尚未创建组件实例,ref(0)又为undefind,那是否是因为是在组件加载完成之后才能执行ref(0).value的语句呢,于是将执行ref(0).value的语句的代码放在onmounted生命周期函数里,成功, 最终代码如下:

<template>
  <div class="img-verify">
    <canvas ref="verify" :width="data.width" :height="data.height" @click="handleDraw"></canvas>
  </div>
</template>

<script>
import { reactive ,ref,onMounted} from 'vue';
export default {
  setup(props,{emit}){
    const data=reactive({
      pool: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890', // 字符串
      width: 120,
      height: 40,
      imgCode: ''
    })
    const verify=ref(null);
    onMounted(() => {
        // DOM元素将在初始渲染后分配给ref
        console.log(verify.value) // <div>这是根元素</div>
        handleDraw();
      })
    // handleDraw();
    function handleDraw(){
      emit('getImgCode', draw())
    }
    // 1.随机数
    function randomNum(min, max) {
      return parseInt(Math.random() * (max - min) + min)
    }
    // 2.随机颜色
    function randomColor(min, max) {
      const r = randomNum(min, max)
      const g = randomNum(min, max)
      const b = randomNum(min, max)
      return `rgb(${r},${g},${b})`
    }
    
    function draw() {
      // 3.填充背景颜色,背景颜色要浅一点
      const ctx = verify.value.getContext('2d')
      // 填充颜色
      ctx.fillStyle = randomColor(180, 230)
      // 填充的位置
      ctx.fillRect(0, 0, data.width, data.height)
      // 定义paramText
      let imgCode = ''
      // 4.随机产生字符串,并且随机旋转
      for (let i = 0; i < 4; i++) {
        // 随机的四个字
        const text = data.pool[randomNum(0, data.pool.length)]
        imgCode += text
        // 随机的字体大小
        const fontSize = randomNum(18, 40)
        // 字体随机的旋转角度
        const deg = randomNum(-30, 30)
        /*
         * 绘制文字并让四个文字在不同的位置显示的思路 :
         * 1、定义字体
         * 2、定义对齐方式
         * 3、填充不同的颜色
         * 4、保存当前的状态(以防止以上的状态受影响)
         * 5、平移translate()
         * 6、旋转 rotate()
         * 7、填充文字
         * 8、restore出栈
         * */
        ctx.font = fontSize + 'px Simhei'
        ctx.textBaseline = 'top'
        ctx.fillStyle = randomColor(80, 150)
        /*
         * save() 方法把当前状态的一份拷贝压入到一个保存图像状态的栈中。
         * 这就允许您临时地改变图像状态,
         * 然后,通过调用 restore() 来恢复以前的值。
         * save是入栈,restore是出栈。
         * 用来保存Canvas的状态。save之后,可以调用Canvas的平移、放缩、旋转、错切、裁剪等操作。 restore:用来恢复Canvas之前保存的状态。防止save后对Canvas执行的操作对后续的绘制有影响。
         *
         * */
        ctx.save()
        ctx.translate(30 * i + 15, 15)
        ctx.rotate((deg * Math.PI) / 180)
        // fillText() 方法在画布上绘制填色的文本。文本的默认颜色是黑色。
        // 请使用 font 属性来定义字体和字号,并使用 fillStyle 属性以另一种颜色/渐变来渲染文本。
        // context.fillText(text,x,y,maxdata.width);
        ctx.fillText(text, -15 + 5, -15)
        ctx.restore()
      }
      // 5.随机产生5条干扰线,干扰线的颜色要浅一点
      for (let i = 0; i < 5; i++) {
        ctx.beginPath()
        ctx.moveTo(randomNum(0, data.width), randomNum(0, data.height))
        ctx.lineTo(randomNum(0, data.width), randomNum(0, data.height))
        ctx.strokeStyle = randomColor(180, 230)
        ctx.closePath()
        ctx.stroke()
      }
      // 6.随机产生40个干扰的小点
      for (let i = 0; i < 40; i++) {
        ctx.beginPath()
        ctx.arc(randomNum(0, data.width), randomNum(0, data.height), 1, 0, 2 * Math.PI)
        ctx.closePath()
        ctx.fillStyle = randomColor(150, 200)
        ctx.fill()
      }
      return imgCode
    }
    return {data,verify}
  }
  

  
}
</script>
<style type="text/css">
.img-verify canvas {
  cursor: pointer;
}
</style>

总结:看来还是没有深刻的理解好概念,还需好好修炼