Flutter之Widget大小与位置

在某些需求下，我们需要获取Widget的大小或位置信息。但Widget对象本身没有大小及位置数据，那么想要拿到Widget的大小及位置信息，就需要通过与Widget对象相关联的RenderBox对象来获取。

下面就开始来获取Widget的大小与位置。

1、获取RenderBox对象

要想获取RenderBox对象，其实很简单。只需要调用BuildContext的findRenderObject方法即可。代码如下。

//context是一个BuildContext对象
RenderBox renderBox = context.findRenderObject();

但有时候，并不能顺利的拿到BuildContext对象，那该怎么办尼？这时候就需要给Widget对象设置一个Key，然后根据这个Key来拿到BuildContext对象，从而获取RenderBox对象，代码如下。

class MyHomePageState extends State<MyHomePage> {
  //定义一个key
  GlobalKey _key = GlobalKey();
  _getRenderBox() {
    //获取`RenderBox`对象
    RenderBox renderBox = _key.currentContext.findRenderObject();
  }
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(),
      body: Column(
        children: <Widget>[
          Flexible(
            flex: 2,
            child: Container(
              //设置key
              key: _key,
              color: Colors.red,
            ),
          ),
        ],
      ),
    );
  }
}

但在使用的时候，我们会发现如果在initState方法通过上面的代码来获取RenderBox对象是不会成功且报错的。这是为什么尼？其实在调用initState方法时，Widget还未完成渲染，也就不能获取RenderBox对象。这时候只需要等待Widget渲染完毕即可。代码如下。

class MyHomePageState extends State<MyHomePage> {
  @override
  void initState() {
    //监听Widget是否绘制完毕
    WidgetsBinding.instance.addPostFrameCallback(_getRenderBox);
    super.initState();
  }
  //定义一个key
  GlobalKey _key = GlobalKey();
  _getRenderBox(_) {
    //获取`RenderBox`对象
    RenderBox renderBox = _key.currentContext.findRenderObject();
  }
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(),
      body: Column(
        children: <Widget>[
          Flexible(
            flex: 2,
            child: Container(
              //设置key
              key: _key,
              color: Colors.red,
            ),
          ),
        ],
      ),
    );
  }
}

2、获取Widget的大小

拿到与Widget对象相关联的RenderBox对象来后，就可以很方便的获取Widget的大小。代码如下。

Size size = renderBox.size;

下面来看一个示例。

class HomeState extends State<HomeWidget> {
  @override
  void initState() {
    //监听Widget是否绘制完毕
    WidgetsBinding.instance.addPostFrameCallback(_afterLayout);
    super.initState();
  }

  void _afterLayout(_) {
    _getSizes();
  }

  _getSizes() {
    final RenderBox renderBoxRed = _keyRed.currentContext.findRenderObject();
    final sizeRed = renderBoxRed.size;
    //输出背景为红色的widget的宽高
    print("size of red:$sizeRed");
    final RenderBox renderBoxBlue = _keyBlue.currentContext.findRenderObject();
    final sizeBlue = renderBoxBlue.size;
    //输出背景为蓝色的widget的宽高
    print("size of Blue:$sizeBlue");
    final RenderBox renderBoxAmber =_keyAmber.currentContext.findRenderObject();
    final sizeAmber = renderBoxAmber.size;
    //输出背景为的widget的宽高
    print("size of Amber:$sizeAmber");
  }

  GlobalKey _keyRed = GlobalKey();
  GlobalKey _keyBlue = GlobalKey();
  GlobalKey _keyAmber = GlobalKey();

  @override
  Widget build(BuildContext context) {
    return Column(
      children: <Widget>[
        Flexible(
          key: _keyRed,
          flex: 1,
          child: Container(
            color: Colors.red,
          ),
        ),
        Flexible(
          key: _keyBlue,
          child: Container(
            color: Colors.blue,
          ),
          flex: 2,
        ),
        Container(
          key: _keyAmber,
          width: 300,
          height: 200,
          color: Colors.amber,
        ),
      ],
    );
  }
}

运行上面代码就可以把Widget的宽高获取到，输出信息如下。

size of red:Size(411.4, 134.5)
size of Blue:Size(411.4, 269.0)
size of Amber:Size(300.0, 200.0)

可以发现，获取的宽高都具有设备无关性。

3、获取Widget的位置

获取Widget的位置跟获取其宽高一样简单，只需要调用不同API即可。如下。

Offset offset = renderBox.localToGlobal(Offset.zero);

下面来看一个示例。

class HomeState extends State<HomeWidget> {
  @override
  void initState() {
    //监听Widget是否绘制完毕
    WidgetsBinding.instance.addPostFrameCallback(_afterLayout);
    super.initState();
  }

  void _afterLayout(_) {
    _getPositions();
  }

  _getPositions() {
    final RenderBox renderBoxRed = _keyRed.currentContext.findRenderObject();
    final positionsRed = renderBoxRed.localToGlobal(Offset(0, 0));
    print("positions of red:$positionsRed");
    final RenderBox renderBoxBlue = _keyBlue.currentContext.findRenderObject();
    final positionsBlue = renderBoxBlue.localToGlobal(Offset(0, 0));
    print("positions of Blue:$positionsBlue");
    final RenderBox renderBoxAmber =
    _keyAmber.currentContext.findRenderObject();
    final positionsAmber = renderBoxAmber.localToGlobal(Offset(0, 0));
    print("positions of Amber:$positionsAmber");
  }

  GlobalKey _keyRed = GlobalKey();
  GlobalKey _keyBlue = GlobalKey();
  GlobalKey _keyAmber = GlobalKey();

  @override
  Widget build(BuildContext context) {
    return Column(
      children: <Widget>[
        Flexible(
          key: _keyRed,
          flex: 1,
          child: Container(
            color: Colors.red,
          ),
        ),
        Flexible(
          key: _keyBlue,
          child: Container(
            color: Colors.blue,
          ),
          flex: 2,
        ),
        //该Widget是居中显示的
        Container(
          key: _keyAmber,
          width: 300,
          height: 200,
          color: Colors.amber,
        ),
      ],
    );
  }
}

运行上面代码就可以把Widget的位置获取到，输出信息如下。

positions of red:Offset(0.0, 80.0)
positions of Blue:Offset(0.0, 214.5)
positions of Amber:Offset(55.7, 483.4)

Flutter跟Android一样，都是以屏幕左上方为坐标系的开始位置。而上面的输出信息就是Widget到坐标系的开始位置的距离。如下图所示。

4、总结

通过上面的代码，就可以获取到Widget的大小及位置信息，这在很多时候都是非常有用的。特别是当我们来自己实现一个自定义Widget的点击、手势等事件时，就需要跟位置信息来获取事件在Widget中的位置。

【参考资料】

Flutter : Widget Size and Position