Streamlit设置key后st_aggrid无法随数据更新的问题咨询

问题场景 #

通过选择偏移量（1000/2000/3000）生成不同的DataFrame，原生st.dataframe和组件描述能正常随偏移量更新，但给AgGrid添加固定key参数后，组件就不再更新数据了。

代码示例 #

import streamlit as st
from st_aggrid import *
import pandas as pd

offset = int(st.selectbox("Offset", ["1000", "2000", "3000"]))

df = pd.DataFrame({"col1":[10,11,12,13], "col2":[20,21,22,23]}) + offset

st.subheader("DataFrame")
st.dataframe(df)

st.subheader("st_aggrid")
ag1 = AgGrid(df,
       # key="unique_key",  # 取消注释后出现问题
       update_mode=GridUpdateMode.VALUE_CHANGED
)

st.subheader("st_aggrid description")
st.write(ag1)

原因分析 #

这不是bug，是Streamlit组件的状态绑定机制导致的：

• 当给组件指定固定key时，Streamlit会将该组件的所有状态（包括渲染的数据、交互状态）与这个key绑定，默认复用之前的状态，不会重新渲染新数据。
• 原生st.dataframe未指定key，每次数据变化时Streamlit会自动识别并重新渲染，所以能正常更新。

解决办法 #

方法1：移除固定key（简单直接） #

如果不需要保留组件的交互状态（比如排序、筛选），直接去掉key参数，让Streamlit自动管理组件状态即可。

方法2：使用动态key（推荐） #

把key设置成和数据关联的动态值，比如包含偏移量，这样每次数据变化时key也跟着变，Streamlit会认为是新组件，重新渲染最新数据：

ag1 = AgGrid(df,
       key=f"aggrid_{offset}",  # 动态key随offset变化
       update_mode=GridUpdateMode.VALUE_CHANGED
)

方法3：保留交互状态同时更新数据 #

如果需要保留组件的交互状态（比如用户设置的排序、筛选），同时更新数据，可以结合session_state和reload_data参数：

# 初始化session_state
if "aggrid_key" not in st.session_state:
    st.session_state.aggrid_key = 0
    st.session_state.last_offset = offset

# 当偏移量变化时，更新key触发刷新
if st.session_state.last_offset != offset:
    st.session_state.aggrid_key += 1
    st.session_state.last_offset = offset

ag1 = AgGrid(df,
       key=f"aggrid_{st.session_state.aggrid_key}",
       update_mode=GridUpdateMode.VALUE_CHANGED,
       reload_data=True  # 强制重载数据
)

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