Kotlin中独立Helper类调用TextToSpeech无效问题排查与解决

问题描述 #

在Android开发中尝试将TextToSpeech功能从Activity移至独立的Helper类实现，但调用后功能完全无效（无报错），而将逻辑直接写在Activity内时功能正常。

原Helper类代码 #

// Helper.kt
class Helper {
    private var tts: TextToSpeech? = null

    fun initTextToSpeech(context: Context) {
        // 롤리팝(API 21, Android 5.0)이상에서만 지원됨
        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
            Toast.makeText(context, "지원하지 않는 SDK 버전입니다.", Toast.LENGTH_SHORT).show()
            return
        }

        tts = TextToSpeech(context) {
            if (it == TextToSpeech.SUCCESS) {
                val result = tts?.setLanguage(Locale.KOREAN)
                if (result == TextToSpeech.LANG_MISSING_DATA || result == TextToSpeech.LANG_NOT_SUPPORTED) {
                    Toast.makeText(context, "지원하지 않는 언어입니다.", Toast.LENGTH_SHORT).show()
//                    return@TextToSpeech
                }
                Toast.makeText(context, "TTS 설정 성공", Toast.LENGTH_SHORT).show()
            } else {
                Toast.makeText(context, "TTS 설정 실패", Toast.LENGTH_SHORT).show()
            }
        }
    }

    fun ttsSpeak(str: String) {
        tts?.speak(str, TextToSpeech.QUEUE_FLUSH, null, "")
    }
}

原Activity调用代码 #

class QuizQuestionsActivity : AppCompatActivity(), View.OnClickListener {

    private var btnAudio: ImageButton? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_quiz_questions)

        Helper().initTextToSpeech(this)

        btnAudio = findViewById(R.id.btn_audio)
        btnAudio?.setOnClickListener(this)

    }

    override fun onClick(view: View?) {
        // 클릭된 view 요소에 따라 메서드 실행
        when (view?.id) {
            R.id.btn_audio -> {
                val question = mQuestionList?.get(mCurrentPosition - 1)
                question?.let { Helper().ttsSpeak(question.question) }
            }
        }
    }
}

核心原因 #

每次调用Helper()都会创建一个全新的Helper实例：

• 在onCreate中新建的Helper实例初始化了tts，但该实例在方法执行完毕后就会被GC回收；
• 点击按钮时又新建了另一个Helper实例，这个实例的tts变量为null，自然无法执行语音合成操作。
  而Activity内直接实现的方式，是持有同一个tts对象，所以功能正常。

解决方案 #

方案1：在Activity中持有Helper实例 #

修改Activity代码，将Helper作为成员变量持有，确保初始化和调用使用的是同一个实例：

class QuizQuestionsActivity : AppCompatActivity(), View.OnClickListener {

    private var btnAudio: ImageButton? = null
    // 持有同一个Helper实例
    private val ttsHelper = Helper()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_quiz_questions)

        ttsHelper.initTextToSpeech(this)

        btnAudio = findViewById(R.id.btn_audio)
        btnAudio?.setOnClickListener(this)

    }

    override fun onClick(view: View?) {
        when (view?.id) {
            R.id.btn_audio -> {
                val question = mQuestionList?.get(mCurrentPosition - 1)
                question?.let { ttsHelper.ttsSpeak(it.question) }
            }
        }
    }

    // 补充：在Activity销毁时释放TTS资源，避免内存泄漏
    override fun onDestroy() {
        super.onDestroy()
        ttsHelper.destroy()
    }
}

同时给Helper类添加资源释放方法：

// Helper.kt中新增
fun destroy() {
    tts?.stop()
    tts?.shutdown()
}

方案2：将Helper设计为单例类 #

修改Helper类为单例模式，确保整个应用中只有一个Helper实例，所有调用都复用该实例：

// Helper.kt
class Helper private constructor() {
    private var tts: TextToSpeech? = null

    // 懒加载单例实例
    companion object {
        val instance by lazy { Helper() }
    }

    fun initTextToSpeech(context: Context) {
        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
            Toast.makeText(context, "지원하지 않는 SDK 버전입니다.", Toast.LENGTH_SHORT).show()
            return
        }

        tts = TextToSpeech(context) {
            if (it == TextToSpeech.SUCCESS) {
                val result = tts?.setLanguage(Locale.KOREAN)
                if (result == TextToSpeech.LANG_MISSING_DATA || result == TextToSpeech.LANG_NOT_SUPPORTED) {
                    Toast.makeText(context, "지원하지 않는 언어입니다.", Toast.LENGTH_SHORT).show()
                }
                Toast.makeText(context, "TTS 설정 성공", Toast.LENGTH_SHORT).show()
            } else {
                Toast.makeText(context, "TTS 설정 실패", Toast.LENGTH_SHORT).show()
            }
        }
    }

    fun ttsSpeak(str: String) {
        tts?.speak(str, TextToSpeech.QUEUE_FLUSH, null, "")
    }

    // 资源释放方法
    fun destroy() {
        tts?.stop()
        tts?.shutdown()
    }
}

Activity调用方式修改为：

class QuizQuestionsActivity : AppCompatActivity(), View.OnClickListener {

    private var btnAudio: ImageButton? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_quiz_questions)

        // 使用单例实例初始化
        Helper.instance.initTextToSpeech(this)

        btnAudio = findViewById(R.id.btn_audio)
        btnAudio?.setOnClickListener(this)

    }

    override fun onClick(view: View?) {
        when (view?.id) {
            R.id.btn_audio -> {
                val question = mQuestionList?.get(mCurrentPosition - 1)
                question?.let { Helper.instance.ttsSpeak(it.question) }
            }
        }
    }

    override fun onDestroy() {
        super.onDestroy()
        Helper.instance.destroy()
    }
}

内容的提问来源于stack exchange，提问作者Julian